org.apache.camel.builder.component.dsl

Interface GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.google.mail.stream.GoogleMailStreamComponent>

All Known Implementing Classes:

GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilderImpl

Enclosing interface:

GoogleMailStreamComponentBuilderFactory

public static interface GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder
extends ComponentBuilder<org.apache.camel.component.google.mail.stream.GoogleMailStreamComponent>

Builder for the Google Mail Stream component.

Method Summary

Modifier and Type	Method and Description
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder	accessToken(String accessToken) OAuth 2 access token.
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder	applicationName(String applicationName) Google mail application name.
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder	autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled.
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder	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.
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder	clientFactory(org.apache.camel.component.google.mail.GoogleMailClientFactory clientFactory) The client Factory.
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder	clientId(String clientId) Client ID of the mail application.
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder	clientSecret(String clientSecret) Client secret of the mail application.
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder	configuration(org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration configuration) The configuration.
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder	labels(String labels) Comma separated list of labels to take into account.
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder	markAsRead(boolean markAsRead) Mark the message as read once it has been consumed.
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder	maxResults(long maxResults) Max results to be returned.
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder	query(String query) The query to execute on gmail box.
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder	refreshToken(String refreshToken) OAuth 2 refresh token.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

build, build, doSetProperty, register

Method Detail

applicationName

default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder 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: consumer

Parameters:

applicationName - the value to set

Returns:

the dsl builder

bridgeErrorHandler

default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder 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 GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder clientId(String clientId)

Client ID of the mail application. The option is a: <code>java.lang.String</code> type. Group: consumer

Parameters:

clientId - the value to set

Returns:

the dsl builder

labels

default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder labels(String labels)

Comma separated list of labels to take into account. The option is a: <code>java.lang.String</code> type. Group: consumer

Parameters:

labels - the value to set

Returns:

the dsl builder

markAsRead

default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder markAsRead(boolean markAsRead)

Mark the message as read once it has been consumed. The option is a: <code>boolean</code> type. Default: true Group: consumer

Parameters:

markAsRead - the value to set

Returns:

the dsl builder

maxResults

default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder maxResults(long maxResults)

Max results to be returned. The option is a: <code>long</code> type. Default: 10 Group: consumer

Parameters:

maxResults - the value to set

Returns:

the dsl builder

query

default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder query(String query)

The query to execute on gmail box. The option is a: <code>java.lang.String</code> type. Default: is:unread Group: consumer

Parameters:

query - the value to set

Returns:

the dsl builder

autowiredEnabled

default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder 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 GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder clientFactory(org.apache.camel.component.google.mail.GoogleMailClientFactory clientFactory)

The client Factory. The option is a: <code>org.apache.camel.component.google.mail.GoogleMailClientFactory</code> type. Group: advanced

Parameters:

clientFactory - the value to set

Returns:

the dsl builder

configuration

default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder configuration(org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration configuration)

The configuration. The option is a: <code>org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration</code> type. Group: advanced

Parameters:

configuration - the value to set

Returns:

the dsl builder

accessToken

default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder 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 GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder 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 GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder 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