Package org.apache.camel.builder.endpoint.dsl

Interface EventbridgeEndpointBuilderFactory.EventbridgeEndpointBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    Enclosing interface:
    EventbridgeEndpointBuilderFactory
    public static interface EventbridgeEndpointBuilderFactory.EventbridgeEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint for the AWS Eventbridge component.

    • Method Detail

      • eventbridgeClient

        default EventbridgeEndpointBuilderFactory.EventbridgeEndpointBuilder eventbridgeClient​(Object eventbridgeClient)
        To use a existing configured AWS Eventbridge as client. The option is a: <code>software.amazon.awssdk.services.eventbridge.EventBridgeClient</code> type. Group: producer
        Parameters:
        eventbridgeClient - the value to set
        Returns:
        the dsl builder

      • eventbridgeClient

        default EventbridgeEndpointBuilderFactory.EventbridgeEndpointBuilder eventbridgeClient​(String eventbridgeClient)
        To use a existing configured AWS Eventbridge as client. The option will be converted to a <code>software.amazon.awssdk.services.eventbridge.EventBridgeClient</code> type. Group: producer
        Parameters:
        eventbridgeClient - the value to set
        Returns:
        the dsl builder

      • lazyStartProducer

        default EventbridgeEndpointBuilderFactory.EventbridgeEndpointBuilder 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 EventbridgeEndpointBuilderFactory.EventbridgeEndpointBuilder 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 EventbridgeEndpointBuilderFactory.EventbridgeEndpointBuilder operation​(String operation)
        The operation to perform. The option will be converted to a <code>org.apache.camel.component.aws2.eventbridge.EventbridgeOperations</code> type. Required: true Default: putRule Group: producer
        Parameters:
        operation - the value to set
        Returns:
        the dsl builder

      • overrideEndpoint

        default EventbridgeEndpointBuilderFactory.EventbridgeEndpointBuilder 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 EventbridgeEndpointBuilderFactory.EventbridgeEndpointBuilder 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 EventbridgeEndpointBuilderFactory.EventbridgeEndpointBuilder 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

      • proxyPort

        default EventbridgeEndpointBuilderFactory.EventbridgeEndpointBuilder proxyPort​(String proxyPort)
        To define a proxy port when instantiating the Eventbridge 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 EventbridgeEndpointBuilderFactory.EventbridgeEndpointBuilder proxyProtocol​(String proxyProtocol)
        To define a proxy protocol when instantiating the Eventbridge 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 EventbridgeEndpointBuilderFactory.EventbridgeEndpointBuilder region​(String region)
        The region in which Eventbridge 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

      • trustAllCertificates

        default EventbridgeEndpointBuilderFactory.EventbridgeEndpointBuilder 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 EventbridgeEndpointBuilderFactory.EventbridgeEndpointBuilder 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 EventbridgeEndpointBuilderFactory.EventbridgeEndpointBuilder 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 EventbridgeEndpointBuilderFactory.EventbridgeEndpointBuilder useDefaultCredentialsProvider​(boolean useDefaultCredentialsProvider)
        Set whether the Eventbridge 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 EventbridgeEndpointBuilderFactory.EventbridgeEndpointBuilder useDefaultCredentialsProvider​(String useDefaultCredentialsProvider)
        Set whether the Eventbridge 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