Package org.apache.camel.builder.component.dsl

Interface GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamComponent>
All Known Implementing Classes:
GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilderImpl
Enclosing interface:
GoogleSheetsStreamComponentBuilderFactory
public static interface GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilder extends ComponentBuilder<org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamComponent>
Builder for the Google Sheets Stream component.

  • Method Details

    • applicationName

      default GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilder 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

    • bridgeErrorHandler

      default GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilder 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

    • clientId

      default GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilder 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

    • configuration

      default GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilder configuration(org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration configuration)
      To use the shared configuration. The option is a: <code>org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration</code> type. Group: consumer
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • delegate

      default GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilder 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 GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilder 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

    • majorDimension

      default GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilder 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 GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilder 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

    • range

      default GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilder 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 GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilder scopes(List<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.List&lt;java.lang.String&gt;</code> type. Group: consumer
      Parameters:
      scopes - the value to set
      Returns:
      the dsl builder

    • splitResults

      default GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilder 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

    • valueRenderOption

      default GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilder 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

    • autowiredEnabled

      default GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • clientFactory

      default GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilder clientFactory(org.apache.camel.component.google.sheets.GoogleSheetsClientFactory clientFactory)
      To use the GoogleSheetsClientFactory as factory for creating the client. Will by default use BatchGoogleSheetsClientFactory. The option is a: <code>org.apache.camel.component.google.sheets.GoogleSheetsClientFactory</code> type. Group: advanced
      Parameters:
      clientFactory - the value to set
      Returns:
      the dsl builder

    • accessToken

      default GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilder 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 GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilder 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 GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilder 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 GoogleSheetsStreamComponentBuilderFactory.GoogleSheetsStreamComponentBuilder 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