Interface GoogleSheetsComponentBuilderFactory.GoogleSheetsComponentBuilder
- All Superinterfaces:
ComponentBuilder<org.apache.camel.component.google.sheets.GoogleSheetsComponent>
- All Known Implementing Classes:
GoogleSheetsComponentBuilderFactory.GoogleSheetsComponentBuilderImpl
- Enclosing interface:
- GoogleSheetsComponentBuilderFactory
public static interface GoogleSheetsComponentBuilderFactory.GoogleSheetsComponentBuilder
extends ComponentBuilder<org.apache.camel.component.google.sheets.GoogleSheetsComponent>
Builder for the Google Sheets component.
-
Method Summary
Modifier and TypeMethodDescriptionaccessToken
(String accessToken) OAuth 2 access token.applicationName
(String applicationName) Google Sheets application name.autowiredEnabled
(boolean autowiredEnabled) Whether autowiring is enabled.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.clientFactory
(org.apache.camel.component.google.sheets.GoogleSheetsClientFactory clientFactory) To use the GoogleSheetsClientFactory as factory for creating the client.Client ID of the sheets application.clientSecret
(String clientSecret) Client secret of the sheets application.configuration
(org.apache.camel.component.google.sheets.GoogleSheetsConfiguration configuration) To use the shared configuration.Delegate for wide-domain service account.lazyStartProducer
(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).refreshToken
(String refreshToken) OAuth 2 refresh token.scopes
(Collection<String> scopes) Sheets scopes.serviceAccountKey
(String serviceAccountKey) Sets .json file with credentials for Service account.splitResult
(boolean splitResult) When consumer return an array or collection this will generate one exchange per element, and their routes will be executed once for each exchange.Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register
-
Method Details
-
applicationName
default GoogleSheetsComponentBuilderFactory.GoogleSheetsComponentBuilder 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: common- Parameters:
applicationName
- the value to set- Returns:
- the dsl builder
-
clientId
Client ID of the sheets application. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
clientId
- the value to set- Returns:
- the dsl builder
-
configuration
default GoogleSheetsComponentBuilderFactory.GoogleSheetsComponentBuilder configuration(org.apache.camel.component.google.sheets.GoogleSheetsConfiguration configuration) To use the shared configuration. The option is a: <code>org.apache.camel.component.google.sheets.GoogleSheetsConfiguration</code> type. Group: common- Parameters:
configuration
- the value to set- Returns:
- the dsl builder
-
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
-
scopes
default GoogleSheetsComponentBuilderFactory.GoogleSheetsComponentBuilder scopes(Collection<String> scopes) Sheets scopes. The option is a: <code>java.util.Collection<java.lang.String></code> type. Group: common- Parameters:
scopes
- the value to set- Returns:
- the dsl builder
-
bridgeErrorHandler
default GoogleSheetsComponentBuilderFactory.GoogleSheetsComponentBuilder 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
-
splitResult
default GoogleSheetsComponentBuilderFactory.GoogleSheetsComponentBuilder splitResult(boolean splitResult) When consumer return an array or collection this will generate one exchange per element, and their routes will be executed once for each exchange. Set this value to false to use a single exchange for the entire list or array. The option is a: <code>boolean</code> type. Default: true Group: consumer- Parameters:
splitResult
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default GoogleSheetsComponentBuilderFactory.GoogleSheetsComponentBuilder lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
autowiredEnabled
default GoogleSheetsComponentBuilderFactory.GoogleSheetsComponentBuilder 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 GoogleSheetsComponentBuilderFactory.GoogleSheetsComponentBuilder 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 GoogleSheetsComponentBuilderFactory.GoogleSheetsComponentBuilder 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 GoogleSheetsComponentBuilderFactory.GoogleSheetsComponentBuilder 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 GoogleSheetsComponentBuilderFactory.GoogleSheetsComponentBuilder 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 GoogleSheetsComponentBuilderFactory.GoogleSheetsComponentBuilder 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
-