SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

SshEndpointBuilderFactory.AdvancedSshEndpointBuilder

Enclosing interface:

SshEndpointBuilderFactory
```
public static interface SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
```
Advanced builder for endpoint consumers for the SSH component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default SshEndpointBuilderFactory.SshEndpointConsumerBuilder`	`basic()`
`default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder`	`channelType(String channelType)` Sets the channel type to pass to the Channel as part of command execution.
`default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder`	`exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler)` To let the consumer use a custom ExceptionHandler.
`default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder`	`exceptionHandler(String exceptionHandler)` To let the consumer use a custom ExceptionHandler.
`default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder`	`exchangePattern(org.apache.camel.ExchangePattern exchangePattern)` Sets the exchange pattern when the consumer creates an exchange.
`default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder`	`exchangePattern(String exchangePattern)` Sets the exchange pattern when the consumer creates an exchange.
`default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder`	`pollStrategy(org.apache.camel.spi.PollingConsumerPollStrategy pollStrategy)` A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
`default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder`	`pollStrategy(String pollStrategy)` A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
`default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder`	`shellPrompt(String shellPrompt)` Sets the shellPrompt to be dropped when response is read after command execution.
`default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder`	`sleepForShellPrompt(long sleepForShellPrompt)` Sets the sleep period in milliseconds to wait reading response from shell prompt.
`default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder`	`sleepForShellPrompt(String sleepForShellPrompt)` Sets the sleep period in milliseconds to wait reading response from shell prompt.
`default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder`	`synchronous(boolean synchronous)` Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
`default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder`	`synchronous(String synchronous)` Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve

- Method Detail
  - basic
```
default SshEndpointBuilderFactory.SshEndpointConsumerBuilder basic()
```
  - exceptionHandler
```
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler)
```
    To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)
    
    Parameters:
    
    exceptionHandler - the value to set
    
    Returns:
    
    the dsl builder
  - exceptionHandler
```
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder exceptionHandler(String exceptionHandler)
```
    To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)
    
    Parameters:
    
    exceptionHandler - the value to set
    
    Returns:
    
    the dsl builder
  - exchangePattern
```
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)
```
    Sets the exchange pattern when the consumer creates an exchange. The option is a: <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)
    
    Parameters:
    
    exchangePattern - the value to set
    
    Returns:
    
    the dsl builder
  - exchangePattern
```
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder exchangePattern(String exchangePattern)
```
    Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)
    
    Parameters:
    
    exchangePattern - the value to set
    
    Returns:
    
    the dsl builder
  - pollStrategy
```
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder pollStrategy(org.apache.camel.spi.PollingConsumerPollStrategy pollStrategy)
```
    A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option is a: <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type. Group: consumer (advanced)
    
    Parameters:
    
    pollStrategy - the value to set
    
    Returns:
    
    the dsl builder
  - pollStrategy
```
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder pollStrategy(String pollStrategy)
```
    A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option will be converted to a <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type. Group: consumer (advanced)
    
    Parameters:
    
    pollStrategy - the value to set
    
    Returns:
    
    the dsl builder
  - channelType
```
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder channelType(String channelType)
```
    Sets the channel type to pass to the Channel as part of command execution. Defaults to exec. The option is a: <code>java.lang.String</code> type. Default: exec Group: advanced
    
    Parameters:
    
    channelType - the value to set
    
    Returns:
    
    the dsl builder
  - shellPrompt
```
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder shellPrompt(String shellPrompt)
```
    Sets the shellPrompt to be dropped when response is read after command execution. The option is a: <code>java.lang.String</code> type. Group: advanced
    
    Parameters:
    
    shellPrompt - the value to set
    
    Returns:
    
    the dsl builder
  - sleepForShellPrompt
```
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder sleepForShellPrompt(long sleepForShellPrompt)
```
    Sets the sleep period in milliseconds to wait reading response from shell prompt. Defaults to 100 milliseconds. The option is a: <code>long</code> type. Default: 100 Group: advanced
    
    Parameters:
    
    sleepForShellPrompt - the value to set
    
    Returns:
    
    the dsl builder
  - sleepForShellPrompt
```
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder sleepForShellPrompt(String sleepForShellPrompt)
```
    Sets the sleep period in milliseconds to wait reading response from shell prompt. Defaults to 100 milliseconds. The option will be converted to a <code>long</code> type. Default: 100 Group: advanced
    
    Parameters:
    
    sleepForShellPrompt - the value to set
    
    Returns:
    
    the dsl builder
  - synchronous
```
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder synchronous(boolean synchronous)
```
    Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option is a: <code>boolean</code> type. Default: false Group: advanced
    
    Parameters:
    
    synchronous - the value to set
    
    Returns:
    
    the dsl builder
  - synchronous
```
default SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder synchronous(String synchronous)
```
    Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
    
    Parameters:
    
    synchronous - the value to set
    
    Returns:
    
    the dsl builder

Interface SshEndpointBuilderFactory.AdvancedSshEndpointConsumerBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

basic

exceptionHandler

exceptionHandler

exchangePattern

exchangePattern

pollStrategy

pollStrategy

channelType

shellPrompt

sleepForShellPrompt

sleepForShellPrompt

synchronous

synchronous