Interface GoogleCalendarComponentBuilderFactory.GoogleCalendarComponentBuilder
- All Superinterfaces:
ComponentBuilder<org.apache.camel.component.google.calendar.GoogleCalendarComponent>
- All Known Implementing Classes:
GoogleCalendarComponentBuilderFactory.GoogleCalendarComponentBuilderImpl
- Enclosing interface:
GoogleCalendarComponentBuilderFactory
public static interface GoogleCalendarComponentBuilderFactory.GoogleCalendarComponentBuilder
extends ComponentBuilder<org.apache.camel.component.google.calendar.GoogleCalendarComponent>
Builder for the Google Calendar component.
-
Method Summary
Modifier and TypeMethodDescriptionaccessToken
(String accessToken) OAuth 2 access token.applicationName
(String applicationName) Google calendar 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 (if possible) occurred while the Camel 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.calendar.GoogleCalendarClientFactory clientFactory) To use the GoogleCalendarClientFactory as factory for creating the client.Client ID of the calendar application.clientSecret
(String clientSecret) Client secret of the calendar application.configuration
(org.apache.camel.component.google.calendar.GoogleCalendarConfiguration configuration) To use the shared configuration.Delegate for wide-domain service account.emailAddress
(String emailAddress) The emailAddress of the Google Service Account.lazyStartProducer
(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).p12FileName
(String p12FileName) The name of the p12 file which has the private key to use with the Google Service Account.refreshToken
(String refreshToken) OAuth 2 refresh token.Specifies the level of permissions you want a calendar application to have to a user account.serviceAccountKey
(String serviceAccountKey) Service account key in json format to authenticate an application as a service account.The email address of the user the application is trying to impersonate in the service account flow.Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register
-
Method Details
-
applicationName
default GoogleCalendarComponentBuilderFactory.GoogleCalendarComponentBuilder applicationName(String applicationName) Google calendar application name. Example would be camel-google-calendar/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 GoogleCalendarComponentBuilderFactory.GoogleCalendarComponentBuilder clientId(String clientId) Client ID of the calendar 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 GoogleCalendarComponentBuilderFactory.GoogleCalendarComponentBuilder configuration(org.apache.camel.component.google.calendar.GoogleCalendarConfiguration configuration) To use the shared configuration. The option is a: <code>org.apache.camel.component.google.calendar.GoogleCalendarConfiguration</code> type. Group: common- Parameters:
configuration
- the value to set- Returns:
- the dsl builder
-
delegate
default GoogleCalendarComponentBuilderFactory.GoogleCalendarComponentBuilder 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
-
scopes
default GoogleCalendarComponentBuilderFactory.GoogleCalendarComponentBuilder scopes(List<String> scopes) Specifies the level of permissions you want a calendar application to have to a user account. You can separate multiple scopes by comma. See https://developers.google.com/google-apps/calendar/auth for more info. The option is a: <code>java.util.List<java.lang.String></code> type. Default: https://www.googleapis.com/auth/calendar Group: common- Parameters:
scopes
- the value to set- Returns:
- the dsl builder
-
bridgeErrorHandler
default GoogleCalendarComponentBuilderFactory.GoogleCalendarComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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
-
lazyStartProducer
default GoogleCalendarComponentBuilderFactory.GoogleCalendarComponentBuilder 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 GoogleCalendarComponentBuilderFactory.GoogleCalendarComponentBuilder 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 GoogleCalendarComponentBuilderFactory.GoogleCalendarComponentBuilder clientFactory(org.apache.camel.component.google.calendar.GoogleCalendarClientFactory clientFactory) To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleCalendarClientFactory. The option is a: <code>org.apache.camel.component.google.calendar.GoogleCalendarClientFactory</code> type. Group: advanced- Parameters:
clientFactory
- the value to set- Returns:
- the dsl builder
-
accessToken
default GoogleCalendarComponentBuilderFactory.GoogleCalendarComponentBuilder 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 GoogleCalendarComponentBuilderFactory.GoogleCalendarComponentBuilder clientSecret(String clientSecret) Client secret of the calendar application. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
clientSecret
- the value to set- Returns:
- the dsl builder
-
emailAddress
default GoogleCalendarComponentBuilderFactory.GoogleCalendarComponentBuilder emailAddress(String emailAddress) The emailAddress of the Google Service Account. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
emailAddress
- the value to set- Returns:
- the dsl builder
-
p12FileName
default GoogleCalendarComponentBuilderFactory.GoogleCalendarComponentBuilder p12FileName(String p12FileName) The name of the p12 file which has the private key to use with the Google Service Account. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
p12FileName
- the value to set- Returns:
- the dsl builder
-
refreshToken
default GoogleCalendarComponentBuilderFactory.GoogleCalendarComponentBuilder 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 GoogleCalendarComponentBuilderFactory.GoogleCalendarComponentBuilder 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
-
user
The email address of the user the application is trying to impersonate in the service account flow. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
user
- the value to set- Returns:
- the dsl builder
-