SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder (Camel

All Superinterfaces:

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

Enclosing interface:

SecretsManagerEndpointBuilderFactory
```
public static interface SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
```
Builder for endpoint for the AWS Secrets Manager component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`accessKey(String accessKey)` Amazon AWS Access Key.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`binaryPayload(boolean binaryPayload)` Set if the secret is binary or not.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`binaryPayload(String binaryPayload)` Set if the secret is binary or not.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`lazyStartProducer(String lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`operation(SecretsManagerEndpointBuilderFactory.SecretsManagerOperations operation)` The operation to perform.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`operation(String operation)` The operation to perform.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`overrideEndpoint(boolean overrideEndpoint)` Set the need for overidding the endpoint.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`overrideEndpoint(String overrideEndpoint)` Set the need for overidding the endpoint.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`pojoRequest(boolean pojoRequest)` If we want to use a POJO request as body or not.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`pojoRequest(String pojoRequest)` If we want to use a POJO request as body or not.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`proxyHost(String proxyHost)` To define a proxy host when instantiating the Secrets Manager client.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`proxyPort(Integer proxyPort)` To define a proxy port when instantiating the Secrets Manager client.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`proxyPort(String proxyPort)` To define a proxy port when instantiating the Secrets Manager client.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`proxyProtocol(SecretsManagerEndpointBuilderFactory.Protocol proxyProtocol)` To define a proxy protocol when instantiating the Secrets Manager client.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`proxyProtocol(String proxyProtocol)` To define a proxy protocol when instantiating the Secrets Manager client.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`region(String region)` The region in which Secrets Manager client needs to work.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`secretKey(String secretKey)` Amazon AWS Secret Key.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`secretsManagerClient(Object secretsManagerClient)` To use a existing configured AWS Secrets Manager as client.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`secretsManagerClient(String secretsManagerClient)` To use a existing configured AWS Secrets Manager as client.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`trustAllCertificates(boolean trustAllCertificates)` If we want to trust all certificates in case of overriding the endpoint.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`trustAllCertificates(String trustAllCertificates)` If we want to trust all certificates in case of overriding the endpoint.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`uriEndpointOverride(String uriEndpointOverride)` Set the overriding uri endpoint.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)` Set whether the Translate client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.
`default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder`	`useDefaultCredentialsProvider(String useDefaultCredentialsProvider)` Set whether the Translate client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.

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
  - binaryPayload
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder binaryPayload(boolean binaryPayload)
```
    Set if the secret is binary or not. The option is a: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    binaryPayload - the value to set
    
    Returns:
    
    the dsl builder
  - binaryPayload
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder binaryPayload(String binaryPayload)
```
    Set if the secret is binary or not. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    binaryPayload - the value to set
    
    Returns:
    
    the dsl builder
  - lazyStartProducer
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder 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 SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder 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
  - operation
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder operation(SecretsManagerEndpointBuilderFactory.SecretsManagerOperations operation)
```
    The operation to perform. The option is a: <code>org.apache.camel.component.aws.secretsmanager.SecretsManagerOperations</code> type. Required: true Group: producer
    
    Parameters:
    
    operation - the value to set
    
    Returns:
    
    the dsl builder
  - operation
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder operation(String operation)
```
    The operation to perform. The option will be converted to a <code>org.apache.camel.component.aws.secretsmanager.SecretsManagerOperations</code> type. Required: true Group: producer
    
    Parameters:
    
    operation - the value to set
    
    Returns:
    
    the dsl builder
  - overrideEndpoint
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder overrideEndpoint(boolean overrideEndpoint)
```
    Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option is a: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    overrideEndpoint - the value to set
    
    Returns:
    
    the dsl builder
  - overrideEndpoint
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder overrideEndpoint(String overrideEndpoint)
```
    Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    overrideEndpoint - the value to set
    
    Returns:
    
    the dsl builder
  - pojoRequest
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder pojoRequest(boolean pojoRequest)
```
    If we want to use a POJO request as body or not. The option is a: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    pojoRequest - the value to set
    
    Returns:
    
    the dsl builder
  - pojoRequest
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder pojoRequest(String pojoRequest)
```
    If we want to use a POJO request as body or not. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    pojoRequest - the value to set
    
    Returns:
    
    the dsl builder
  - proxyHost
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder proxyHost(String proxyHost)
```
    To define a proxy host when instantiating the Secrets Manager client. The option is a: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    proxyHost - the value to set
    
    Returns:
    
    the dsl builder
  - proxyPort
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder proxyPort(Integer proxyPort)
```
    To define a proxy port when instantiating the Secrets Manager client. The option is a: <code>java.lang.Integer</code> type. Group: producer
    
    Parameters:
    
    proxyPort - the value to set
    
    Returns:
    
    the dsl builder
  - proxyPort
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder proxyPort(String proxyPort)
```
    To define a proxy port when instantiating the Secrets Manager client. The option will be converted to a <code>java.lang.Integer</code> type. Group: producer
    
    Parameters:
    
    proxyPort - the value to set
    
    Returns:
    
    the dsl builder
  - proxyProtocol
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder proxyProtocol(SecretsManagerEndpointBuilderFactory.Protocol proxyProtocol)
```
    To define a proxy protocol when instantiating the Secrets Manager client. The option is a: <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: producer
    
    Parameters:
    
    proxyProtocol - the value to set
    
    Returns:
    
    the dsl builder
  - proxyProtocol
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder proxyProtocol(String proxyProtocol)
```
    To define a proxy protocol when instantiating the Secrets Manager client. The option will be converted to a <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: producer
    
    Parameters:
    
    proxyProtocol - the value to set
    
    Returns:
    
    the dsl builder
  - region
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder region(String region)
```
    The region in which Secrets Manager client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id(). The option is a: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    region - the value to set
    
    Returns:
    
    the dsl builder
  - secretsManagerClient
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder secretsManagerClient(Object secretsManagerClient)
```
    To use a existing configured AWS Secrets Manager as client. The option is a: <code>software.amazon.awssdk.services.secretsmanager.SecretsManagerClient</code> type. Group: producer
    
    Parameters:
    
    secretsManagerClient - the value to set
    
    Returns:
    
    the dsl builder
  - secretsManagerClient
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder secretsManagerClient(String secretsManagerClient)
```
    To use a existing configured AWS Secrets Manager as client. The option will be converted to a <code>software.amazon.awssdk.services.secretsmanager.SecretsManagerClient</code> type. Group: producer
    
    Parameters:
    
    secretsManagerClient - the value to set
    
    Returns:
    
    the dsl builder
  - trustAllCertificates
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder trustAllCertificates(boolean trustAllCertificates)
```
    If we want to trust all certificates in case of overriding the endpoint. The option is a: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    trustAllCertificates - the value to set
    
    Returns:
    
    the dsl builder
  - trustAllCertificates
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder trustAllCertificates(String trustAllCertificates)
```
    If we want to trust all certificates in case of overriding the endpoint. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    trustAllCertificates - the value to set
    
    Returns:
    
    the dsl builder
  - uriEndpointOverride
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder uriEndpointOverride(String uriEndpointOverride)
```
    Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. The option is a: <code>java.lang.String</code> type. Group: producer
    
    Parameters:
    
    uriEndpointOverride - the value to set
    
    Returns:
    
    the dsl builder
  - useDefaultCredentialsProvider
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
```
    Set whether the Translate client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. The option is a: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    useDefaultCredentialsProvider - the value to set
    
    Returns:
    
    the dsl builder
  - useDefaultCredentialsProvider
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder useDefaultCredentialsProvider(String useDefaultCredentialsProvider)
```
    Set whether the Translate client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    useDefaultCredentialsProvider - the value to set
    
    Returns:
    
    the dsl builder
  - accessKey
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder accessKey(String accessKey)
```
    Amazon AWS Access Key. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    accessKey - the value to set
    
    Returns:
    
    the dsl builder
  - secretKey
```
default SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder secretKey(String secretKey)
```
    Amazon AWS Secret Key. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    secretKey - the value to set
    
    Returns:
    
    the dsl builder

Interface SecretsManagerEndpointBuilderFactory.SecretsManagerEndpointBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointProducerResolver

Method Detail

binaryPayload

binaryPayload

lazyStartProducer

lazyStartProducer

operation

operation

overrideEndpoint

overrideEndpoint

pojoRequest

pojoRequest

proxyHost

proxyPort

proxyPort

proxyProtocol

proxyProtocol

region

secretsManagerClient

secretsManagerClient

trustAllCertificates

trustAllCertificates

uriEndpointOverride

useDefaultCredentialsProvider

useDefaultCredentialsProvider

accessKey

secretKey