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

Interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder
Enclosing interface:
GoogleMailEndpointBuilderFactory
public static interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Google Mail component.

  • Method Details

    • advanced

      default GoogleMailEndpointBuilderFactory.AdvancedGoogleMailEndpointConsumerBuilder advanced()

    • applicationName

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder applicationName(String applicationName)
      Google mail application name. Example would be camel-google-mail/1.0. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      applicationName - the value to set
      Returns:
      the dsl builder

    • clientId

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder clientId(String clientId)
      Client ID of the mail application. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      clientId - the value to set
      Returns:
      the dsl builder

    • delegate

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder delegate(String delegate)
      Delegate for wide-domain service account. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      delegate - the value to set
      Returns:
      the dsl builder

    • inBody

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder inBody(String inBody)
      Sets the name of a parameter to be passed in the exchange In Body. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      inBody - the value to set
      Returns:
      the dsl builder

    • scopes

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder scopes(Collection<String> scopes)
      GMail scopes. The option is a: <code>java.util.Collection&lt;java.lang.String&gt;</code> type. Group: common
      Parameters:
      scopes - the value to set
      Returns:
      the dsl builder

    • scopes

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder scopes(String scopes)
      GMail scopes. The option will be converted to a <code>java.util.Collection&lt;java.lang.String&gt;</code> type. Group: common
      Parameters:
      scopes - the value to set
      Returns:
      the dsl builder

    • sendEmptyMessageWhenIdle

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle)
      If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder

    • sendEmptyMessageWhenIdle

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle)
      If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder

    • backoffErrorThreshold

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder backoffErrorThreshold(int backoffErrorThreshold)
      The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder

    • backoffErrorThreshold

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder backoffErrorThreshold(String backoffErrorThreshold)
      The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder

    • backoffIdleThreshold

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold)
      The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder

    • backoffIdleThreshold

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder backoffIdleThreshold(String backoffIdleThreshold)
      The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder

    • backoffMultiplier

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder backoffMultiplier(int backoffMultiplier)
      To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option is a: <code>int</code> type. Group: scheduler
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder

    • backoffMultiplier

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder backoffMultiplier(String backoffMultiplier)
      To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option will be converted to a <code>int</code> type. Group: scheduler
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder

    • delay

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder delay(long delay)
      Milliseconds before the next poll. The option is a: <code>long</code> type. Default: 500 Group: scheduler
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder

    • delay

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder delay(String delay)
      Milliseconds before the next poll. The option will be converted to a <code>long</code> type. Default: 500 Group: scheduler
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder

    • greedy

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder greedy(boolean greedy)
      If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: <code>boolean</code> type. Default: false Group: scheduler
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder

    • greedy

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder greedy(String greedy)
      If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a <code>boolean</code> type. Default: false Group: scheduler
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder

    • initialDelay

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder initialDelay(long initialDelay)
      Milliseconds before the first poll starts. The option is a: <code>long</code> type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder

    • initialDelay

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder initialDelay(String initialDelay)
      Milliseconds before the first poll starts. The option will be converted to a <code>long</code> type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder

    • repeatCount

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder repeatCount(long repeatCount)
      Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a: <code>long</code> type. Default: 0 Group: scheduler
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder

    • repeatCount

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder repeatCount(String repeatCount)
      Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to a <code>long</code> type. Default: 0 Group: scheduler
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder

    • runLoggingLevel

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
      The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder

    • runLoggingLevel

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder runLoggingLevel(String runLoggingLevel)
      The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder

    • scheduledExecutorService

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
      Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder

    • scheduledExecutorService

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder scheduledExecutorService(String scheduledExecutorService)
      Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to a <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder

    • scheduler

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder scheduler(Object scheduler)
      To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: <code>java.lang.Object</code> type. Default: none Group: scheduler
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder

    • scheduler

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder scheduler(String scheduler)
      To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a <code>java.lang.Object</code> type. Default: none Group: scheduler
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder

    • schedulerProperties

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder schedulerProperties(String key, Object value)
      To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder

    • schedulerProperties

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder schedulerProperties(Map values)
      To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
      Parameters:
      values - the values
      Returns:
      the dsl builder

    • startScheduler

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder startScheduler(boolean startScheduler)
      Whether the scheduler should be auto started. The option is a: <code>boolean</code> type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder

    • startScheduler

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder startScheduler(String startScheduler)
      Whether the scheduler should be auto started. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder

    • timeUnit

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder timeUnit(TimeUnit timeUnit)
      Time unit for initialDelay and delay options. The option is a: <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder

    • timeUnit

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder timeUnit(String timeUnit)
      Time unit for initialDelay and delay options. The option will be converted to a <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder

    • useFixedDelay

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder useFixedDelay(boolean useFixedDelay)
      Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: <code>boolean</code> type. Default: true Group: scheduler
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder

    • useFixedDelay

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder useFixedDelay(String useFixedDelay)
      Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder

    • accessToken

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder accessToken(String accessToken)
      OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      accessToken - the value to set
      Returns:
      the dsl builder

    • clientSecret

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder clientSecret(String clientSecret)
      Client secret of the mail application. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      clientSecret - the value to set
      Returns:
      the dsl builder

    • refreshToken

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder refreshToken(String refreshToken)
      OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      refreshToken - the value to set
      Returns:
      the dsl builder

    • serviceAccountKey

      default GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder serviceAccountKey(String serviceAccountKey)
      Service account key in json format to authenticate an application as a service account. Accept base64 adding the prefix base64:. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      serviceAccountKey - the value to set
      Returns:
      the dsl builder