org.apache.camel.builder.endpoint.dsl

Interface GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

GitHubEndpointBuilderFactory.GitHubEndpointBuilder

Enclosing interface:

GitHubEndpointBuilderFactory

public static interface GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the GitHub component.

Method Summary

Modifier and Type	Method and Description
default GitHubEndpointBuilderFactory.AdvancedGitHubEndpointProducerBuilder	advanced()
default GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder	encoding(String encoding) To use the given encoding when getting a git commit file.
default GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder	oauthToken(String oauthToken) GitHub OAuth token, required unless username & password are provided.
default GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder	password(String password) GitHub password, required unless oauthToken is provided.
default GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder	repoName(String repoName) GitHub repository name.
default GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder	repoOwner(String repoOwner) GitHub repository owner (organization).
default GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder	state(String state) To set git commit status state.
default GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder	targetUrl(String targetUrl) To set git commit status target url.
default GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder	username(String username) GitHub username, required unless oauthToken is provided.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default GitHubEndpointBuilderFactory.AdvancedGitHubEndpointProducerBuilder advanced()

oauthToken

default GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder oauthToken(String oauthToken)

GitHub OAuth token, required unless username & password are provided. The option is a: java.lang.String type. Group: common

password

default GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder password(String password)

GitHub password, required unless oauthToken is provided. The option is a: java.lang.String type. Group: common

repoName

default GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder repoName(String repoName)

GitHub repository name. The option is a: java.lang.String type. Required: true Group: common

repoOwner

default GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder repoOwner(String repoOwner)

GitHub repository owner (organization). The option is a: java.lang.String type. Required: true Group: common

username

default GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder username(String username)

GitHub username, required unless oauthToken is provided. The option is a: java.lang.String type. Group: common

encoding

default GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder encoding(String encoding)

To use the given encoding when getting a git commit file. The option is a: java.lang.String type. Group: producer

lazyStartProducer

default GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder 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: boolean type. Default: false Group: producer

lazyStartProducer

default GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder 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 boolean type. Default: false Group: producer

state

default GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder state(String state)

To set git commit status state. The option is a: java.lang.String type. Group: producer

targetUrl

default GitHubEndpointBuilderFactory.GitHubEndpointProducerBuilder targetUrl(String targetUrl)

To set git commit status target url. The option is a: java.lang.String type. Group: producer