org.apache.camel.builder.endpoint.dsl

Interface GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointProducerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointBuilder

Enclosing interface:

GoogleSheetsEndpointBuilderFactory

public static interface GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the Google Sheets component.

Method Summary

Modifier and Type	Method and Description
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointProducerBuilder	accessToken(String accessToken) OAuth 2 access token.
default GoogleSheetsEndpointBuilderFactory.AdvancedGoogleSheetsEndpointProducerBuilder	advanced()
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointProducerBuilder	applicationName(String applicationName) Google Sheets application name.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointProducerBuilder	clientId(String clientId) Client ID of the sheets application.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointProducerBuilder	clientSecret(String clientSecret) Client secret of the sheets application.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointProducerBuilder	inBody(String inBody) Sets the name of a parameter to be passed in the exchange In Body.
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointProducerBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointProducerBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointProducerBuilder	refreshToken(String refreshToken) OAuth 2 refresh token.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default GoogleSheetsEndpointBuilderFactory.AdvancedGoogleSheetsEndpointProducerBuilder advanced()

applicationName

default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointProducerBuilder 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

default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointProducerBuilder clientId(String 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

inBody

default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointProducerBuilder inBody(String inBody)

Sets the name of a parameter to be passed in the exchange In Body. The option is a: <code>java.lang.String</code> type. Group: common

Parameters:

inBody - the value to set

Returns:

the dsl builder

lazyStartProducer

default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointProducerBuilder 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

lazyStartProducer

default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointProducerBuilder lazyStartProducer(String 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 will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

accessToken

default GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointProducerBuilder 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 GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointProducerBuilder 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 GoogleSheetsEndpointBuilderFactory.GoogleSheetsEndpointProducerBuilder 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