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

Interface GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
Enclosing interface:
GoogleSheetsStreamEndpointBuilderFactory
public static interface GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint for the Google Sheets Stream component.

  • Method Details

    • advanced

      default GoogleSheetsStreamEndpointBuilderFactory.AdvancedGoogleSheetsStreamEndpointBuilder advanced()

    • applicationName

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

    • clientId

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

    • delegate

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

    • includeGridData

      default GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder includeGridData(boolean includeGridData)
      True if grid data should be returned. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      includeGridData - the value to set
      Returns:
      the dsl builder

    • includeGridData

      default GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder includeGridData(String includeGridData)
      True if grid data should be returned. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      includeGridData - the value to set
      Returns:
      the dsl builder

    • majorDimension

      default GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder majorDimension(String majorDimension)
      Specifies the major dimension that results should use.. The option is a: <code>java.lang.String</code> type. Default: ROWS Group: consumer
      Parameters:
      majorDimension - the value to set
      Returns:
      the dsl builder

    • maxResults

      default GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder maxResults(int maxResults)
      Specify the maximum number of returned results. This will limit the number of rows in a returned value range data set or the number of returned value ranges in a batch request. The option is a: <code>int</code> type. Group: consumer
      Parameters:
      maxResults - the value to set
      Returns:
      the dsl builder

    • maxResults

      default GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder maxResults(String maxResults)
      Specify the maximum number of returned results. This will limit the number of rows in a returned value range data set or the number of returned value ranges in a batch request. The option will be converted to a <code>int</code> type. Group: consumer
      Parameters:
      maxResults - the value to set
      Returns:
      the dsl builder

    • range

      default GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder range(String range)
      Specifies the range of rows and columns in a sheet to get data from. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      range - the value to set
      Returns:
      the dsl builder

    • scopes

      default GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder scopes(Collection<String> scopes)
      Specifies the level of permissions you want a sheets application to have to a user account. See https://developers.google.com/identity/protocols/googlescopes for more info. The option is a: <code>java.util.Collection&lt;java.lang.String&gt;</code> type. Group: consumer
      Parameters:
      scopes - the value to set
      Returns:
      the dsl builder

    • scopes

      default GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder scopes(String scopes)
      Specifies the level of permissions you want a sheets application to have to a user account. See https://developers.google.com/identity/protocols/googlescopes for more info. The option will be converted to a <code>java.util.Collection&lt;java.lang.String&gt;</code> type. Group: consumer
      Parameters:
      scopes - the value to set
      Returns:
      the dsl builder

    • sendEmptyMessageWhenIdle

      default GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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

    • splitResults

      default GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder splitResults(boolean splitResults)
      True if value range result should be split into rows or columns to process each of them individually. When true each row or column is represented with a separate exchange in batch processing. Otherwise value range object is used as exchange junk size. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      splitResults - the value to set
      Returns:
      the dsl builder

    • splitResults

      default GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder splitResults(String splitResults)
      True if value range result should be split into rows or columns to process each of them individually. When true each row or column is represented with a separate exchange in batch processing. Otherwise value range object is used as exchange junk size. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      splitResults - the value to set
      Returns:
      the dsl builder

    • valueRenderOption

      default GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder valueRenderOption(String valueRenderOption)
      Determines how values should be rendered in the output. The option is a: <code>java.lang.String</code> type. Default: FORMATTED_VALUE Group: consumer
      Parameters:
      valueRenderOption - the value to set
      Returns:
      the dsl builder

    • backoffErrorThreshold

      default GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder clientSecret(String clientSecret)
      Client secret of the sheets 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder refreshToken(String refreshToken)
      OAuth 2 refresh token. Using this, the Google Sheets 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 GoogleSheetsStreamEndpointBuilderFactory.GoogleSheetsStreamEndpointBuilder serviceAccountKey(String serviceAccountKey)
      Sets .json file with credentials for Service account. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      serviceAccountKey - the value to set
      Returns:
      the dsl builder