Package org.apache.camel.builder.component.dsl

Interface DaprComponentBuilderFactory.DaprComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.dapr.DaprComponent>
All Known Implementing Classes:
DaprComponentBuilderFactory.DaprComponentBuilderImpl
Enclosing interface:
DaprComponentBuilderFactory
public static interface DaprComponentBuilderFactory.DaprComponentBuilder extends ComponentBuilder<org.apache.camel.component.dapr.DaprComponent>
Builder for the Dapr component.

  • Method Details

    • client

      default DaprComponentBuilderFactory.DaprComponentBuilder client(io.dapr.client.DaprClient client)
      The Dapr Client. The option is a: <code>io.dapr.client.DaprClient</code> type. Group: common
      Parameters:
      client - the value to set
      Returns:
      the dsl builder

    • configKeys

      default DaprComponentBuilderFactory.DaprComponentBuilder configKeys(String configKeys)
      List of keys for configuration operation. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      configKeys - the value to set
      Returns:
      the dsl builder

    • configStore

      default DaprComponentBuilderFactory.DaprComponentBuilder configStore(String configStore)
      The name of the Dapr configuration store to interact with, defined in statestore.yaml config. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      configStore - the value to set
      Returns:
      the dsl builder

    • configuration

      default DaprComponentBuilderFactory.DaprComponentBuilder configuration(org.apache.camel.component.dapr.DaprConfiguration configuration)
      The component configurations. The option is a: <code>org.apache.camel.component.dapr.DaprConfiguration</code> type. Group: common
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • contentType

      default DaprComponentBuilderFactory.DaprComponentBuilder contentType(String contentType)
      The contentType for the Pub/Sub component to use. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      contentType - the value to set
      Returns:
      the dsl builder

    • previewClient

      default DaprComponentBuilderFactory.DaprComponentBuilder previewClient(io.dapr.client.DaprPreviewClient previewClient)
      The Dapr Preview Client. The option is a: <code>io.dapr.client.DaprPreviewClient</code> type. Group: common
      Parameters:
      previewClient - the value to set
      Returns:
      the dsl builder

    • pubSubName

      default DaprComponentBuilderFactory.DaprComponentBuilder pubSubName(String pubSubName)
      The name of the Dapr Pub/Sub component to use. This identifies which underlying messaging system Dapr will interact with for publishing or subscribing to events. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      pubSubName - the value to set
      Returns:
      the dsl builder

    • topic

      default DaprComponentBuilderFactory.DaprComponentBuilder topic(String topic)
      The name of the topic to subscribe to. The topic must exist in the Pub/Sub component configured under the given pubsubName. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      topic - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default DaprComponentBuilderFactory.DaprComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • bindingName

      default DaprComponentBuilderFactory.DaprComponentBuilder bindingName(String bindingName)
      The name of the Dapr binding to invoke. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      bindingName - the value to set
      Returns:
      the dsl builder

    • bindingOperation

      default DaprComponentBuilderFactory.DaprComponentBuilder bindingOperation(String bindingOperation)
      The operation to perform on the binding. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      bindingOperation - the value to set
      Returns:
      the dsl builder

    • concurrency

      default DaprComponentBuilderFactory.DaprComponentBuilder concurrency(io.dapr.client.domain.StateOptions.Concurrency concurrency)
      Concurrency mode to use with state operations. The option is a: <code>io.dapr.client.domain.StateOptions.Concurrency</code> type. Group: producer
      Parameters:
      concurrency - the value to set
      Returns:
      the dsl builder

    • consistency

      default DaprComponentBuilderFactory.DaprComponentBuilder consistency(io.dapr.client.domain.StateOptions.Consistency consistency)
      Consistency level to use with state operations. The option is a: <code>io.dapr.client.domain.StateOptions.Consistency</code> type. Group: producer
      Parameters:
      consistency - the value to set
      Returns:
      the dsl builder

    • eTag

      default DaprComponentBuilderFactory.DaprComponentBuilder eTag(String eTag)
      The eTag for optimistic concurrency during state save or delete operations. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      eTag - the value to set
      Returns:
      the dsl builder

    • eventName

      default DaprComponentBuilderFactory.DaprComponentBuilder eventName(String eventName)
      The name of the event. Event names are case-insensitive. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      eventName - the value to set
      Returns:
      the dsl builder

    • expiryInSeconds

      default DaprComponentBuilderFactory.DaprComponentBuilder expiryInSeconds(Integer expiryInSeconds)
      The expiry time in seconds for the lock. The option is a: <code>java.lang.Integer</code> type. Group: producer
      Parameters:
      expiryInSeconds - the value to set
      Returns:
      the dsl builder

    • getWorkflowIO

      default DaprComponentBuilderFactory.DaprComponentBuilder getWorkflowIO(boolean getWorkflowIO)
      Set true to fetch the workflow instance's inputs, outputs, and custom status, or false to omit. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      getWorkflowIO - the value to set
      Returns:
      the dsl builder

    • httpExtension

      default DaprComponentBuilderFactory.DaprComponentBuilder httpExtension(io.dapr.client.domain.HttpExtension httpExtension)
      HTTP method to use when invoking the service. Accepts verbs like GET, POST, PUT, DELETE, etc. Creates a minimal HttpExtension with no headers or query params. Takes precedence over verb. The option is a: <code>io.dapr.client.domain.HttpExtension</code> type. Group: producer
      Parameters:
      httpExtension - the value to set
      Returns:
      the dsl builder

    • key

      default DaprComponentBuilderFactory.DaprComponentBuilder key(String key)
      The key used to identify the state/secret object within the specified state/secret store. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      key - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default DaprComponentBuilderFactory.DaprComponentBuilder 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

    • lockOperation

      default DaprComponentBuilderFactory.DaprComponentBuilder lockOperation(org.apache.camel.component.dapr.LockOperation lockOperation)
      The lock operation to perform on the store. Required for DaprOperation.lock operation. The option is a: <code>org.apache.camel.component.dapr.LockOperation</code> type. Default: tryLock Group: producer
      Parameters:
      lockOperation - the value to set
      Returns:
      the dsl builder

    • lockOwner

      default DaprComponentBuilderFactory.DaprComponentBuilder lockOwner(String lockOwner)
      The lock owner identifier for the lock. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      lockOwner - the value to set
      Returns:
      the dsl builder

    • methodToInvoke

      default DaprComponentBuilderFactory.DaprComponentBuilder methodToInvoke(String methodToInvoke)
      The name of the method or route to invoke on the target service. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      methodToInvoke - the value to set
      Returns:
      the dsl builder

    • reason

      default DaprComponentBuilderFactory.DaprComponentBuilder reason(String reason)
      Reason for suspending/resuming the workflow instance. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      reason - the value to set
      Returns:
      the dsl builder

    • resourceId

      default DaprComponentBuilderFactory.DaprComponentBuilder resourceId(String resourceId)
      The resource Id for the lock. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      resourceId - the value to set
      Returns:
      the dsl builder

    • secretStore

      default DaprComponentBuilderFactory.DaprComponentBuilder secretStore(String secretStore)
      The name of the Dapr secret store to interact with, defined in local-secret-store.yaml config. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      secretStore - the value to set
      Returns:
      the dsl builder

    • serviceToInvoke

      default DaprComponentBuilderFactory.DaprComponentBuilder serviceToInvoke(String serviceToInvoke)
      Target service to invoke. Can be a Dapr App ID, a named HTTPEndpoint, or a FQDN/public URL. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      serviceToInvoke - the value to set
      Returns:
      the dsl builder

    • stateOperation

      default DaprComponentBuilderFactory.DaprComponentBuilder stateOperation(org.apache.camel.component.dapr.StateOperation stateOperation)
      The state operation to perform on the state store. Required for DaprOperation.state operation. The option is a: <code>org.apache.camel.component.dapr.StateOperation</code> type. Default: get Group: producer
      Parameters:
      stateOperation - the value to set
      Returns:
      the dsl builder

    • stateStore

      default DaprComponentBuilderFactory.DaprComponentBuilder stateStore(String stateStore)
      The name of the Dapr state store to interact with, defined in statestore.yaml config. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      stateStore - the value to set
      Returns:
      the dsl builder

    • storeName

      default DaprComponentBuilderFactory.DaprComponentBuilder storeName(String storeName)
      The lock store name. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      storeName - the value to set
      Returns:
      the dsl builder

    • timeout

      default DaprComponentBuilderFactory.DaprComponentBuilder timeout(Duration timeout)
      The amount of time to wait for the workflow instance to start/complete. The option is a: <code>java.time.Duration</code> type. Group: producer
      Parameters:
      timeout - the value to set
      Returns:
      the dsl builder

    • verb

      default DaprComponentBuilderFactory.DaprComponentBuilder verb(String verb)
      The HTTP verb to use for invoking the method. The option is a: <code>java.lang.String</code> type. Default: POST Group: producer
      Parameters:
      verb - the value to set
      Returns:
      the dsl builder

    • workflowClass

      default DaprComponentBuilderFactory.DaprComponentBuilder workflowClass(String workflowClass)
      The FQCN of the class which implements io.dapr.workflows.Workflow. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      workflowClass - the value to set
      Returns:
      the dsl builder

    • workflowClient

      default DaprComponentBuilderFactory.DaprComponentBuilder workflowClient(io.dapr.workflows.client.DaprWorkflowClient workflowClient)
      The Dapr Workflow Client. The option is a: <code>io.dapr.workflows.client.DaprWorkflowClient</code> type. Group: producer
      Parameters:
      workflowClient - the value to set
      Returns:
      the dsl builder

    • workflowInstanceId

      default DaprComponentBuilderFactory.DaprComponentBuilder workflowInstanceId(String workflowInstanceId)
      The instance ID of the workflow. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      workflowInstanceId - the value to set
      Returns:
      the dsl builder

    • workflowOperation

      default DaprComponentBuilderFactory.DaprComponentBuilder workflowOperation(org.apache.camel.component.dapr.WorkflowOperation workflowOperation)
      The workflow operation to perform. Required for DaprOperation.workflow operation. The option is a: <code>org.apache.camel.component.dapr.WorkflowOperation</code> type. Default: scheduleNew Group: producer
      Parameters:
      workflowOperation - the value to set
      Returns:
      the dsl builder

    • workflowStartTime

      default DaprComponentBuilderFactory.DaprComponentBuilder workflowStartTime(Instant workflowStartTime)
      The start time of the new workflow. The option is a: <code>java.time.Instant</code> type. Group: producer
      Parameters:
      workflowStartTime - the value to set
      Returns:
      the dsl builder

    • workflowVersion

      default DaprComponentBuilderFactory.DaprComponentBuilder workflowVersion(String workflowVersion)
      The version of the workflow to start. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      workflowVersion - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default DaprComponentBuilderFactory.DaprComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder