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

Interface TahuEdgeEndpointBuilderFactory.TahuEdgeEndpointBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
Enclosing interface:
TahuEdgeEndpointBuilderFactory
public static interface TahuEdgeEndpointBuilderFactory.TahuEdgeEndpointBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the Tahu Edge Node / Device component.

  • Method Details

    • advanced

      default TahuEdgeEndpointBuilderFactory.AdvancedTahuEdgeEndpointBuilder advanced()

    • checkClientIdLength

      default TahuEdgeEndpointBuilderFactory.TahuEdgeEndpointBuilder checkClientIdLength(boolean checkClientIdLength)
      MQTT client ID length check enabled. The option is a: boolean type. Default: false Group: common
      Parameters:
      checkClientIdLength - the value to set
      Returns:
      the dsl builder

    • checkClientIdLength

      default TahuEdgeEndpointBuilderFactory.TahuEdgeEndpointBuilder checkClientIdLength(String checkClientIdLength)
      MQTT client ID length check enabled. The option will be converted to a boolean type. Default: false Group: common
      Parameters:
      checkClientIdLength - the value to set
      Returns:
      the dsl builder

    • clientId

      default TahuEdgeEndpointBuilderFactory.TahuEdgeEndpointBuilder clientId(String clientId)
      MQTT client ID to use for all server definitions, rather than specifying the same one for each. Note that if neither the 'clientId' parameter nor an 'MqttClientId' are defined for an MQTT Server, a random MQTT Client ID will be generated automatically, prefaced with 'Camel'. The option is a: java.lang.String type. Required: true Group: common
      Parameters:
      clientId - the value to set
      Returns:
      the dsl builder

    • keepAliveTimeout

      default TahuEdgeEndpointBuilderFactory.TahuEdgeEndpointBuilder keepAliveTimeout(int keepAliveTimeout)
      MQTT connection keep alive timeout, in seconds. The option is a: int type. Default: 30 Group: common
      Parameters:
      keepAliveTimeout - the value to set
      Returns:
      the dsl builder

    • keepAliveTimeout

      default TahuEdgeEndpointBuilderFactory.TahuEdgeEndpointBuilder keepAliveTimeout(String keepAliveTimeout)
      MQTT connection keep alive timeout, in seconds. The option will be converted to a int type. Default: 30 Group: common
      Parameters:
      keepAliveTimeout - the value to set
      Returns:
      the dsl builder

    • rebirthDebounceDelay

      default TahuEdgeEndpointBuilderFactory.TahuEdgeEndpointBuilder rebirthDebounceDelay(long rebirthDebounceDelay)
      Delay before recurring node rebirth messages will be sent. The option is a: long type. Default: 5000 Group: common
      Parameters:
      rebirthDebounceDelay - the value to set
      Returns:
      the dsl builder

    • rebirthDebounceDelay

      default TahuEdgeEndpointBuilderFactory.TahuEdgeEndpointBuilder rebirthDebounceDelay(String rebirthDebounceDelay)
      Delay before recurring node rebirth messages will be sent. The option will be converted to a long type. Default: 5000 Group: common
      Parameters:
      rebirthDebounceDelay - the value to set
      Returns:
      the dsl builder

    • servers

      default TahuEdgeEndpointBuilderFactory.TahuEdgeEndpointBuilder servers(String servers)
      MQTT server definitions, given with the following syntax in a comma-separated list: MqttServerName:(MqttClientId:)(tcp/ssl)://hostname(:port),... The option is a: java.lang.String type. Required: true Group: common
      Parameters:
      servers - the value to set
      Returns:
      the dsl builder

    • metricDataTypePayloadMap

      default TahuEdgeEndpointBuilderFactory.TahuEdgeEndpointBuilder metricDataTypePayloadMap(org.eclipse.tahu.message.model.SparkplugBPayloadMap metricDataTypePayloadMap)
      Tahu SparkplugBPayloadMap to configure metric data types for this edge node or device. Note that this payload is used exclusively as a Sparkplug B spec-compliant configuration for all possible edge node or device metric names, aliases, and data types. This configuration is required to publish proper Sparkplug B NBIRTH and DBIRTH payloads. The option is a: org.eclipse.tahu.message.model.SparkplugBPayloadMap type. Required: true Group: producer
      Parameters:
      metricDataTypePayloadMap - the value to set
      Returns:
      the dsl builder

    • metricDataTypePayloadMap

      default TahuEdgeEndpointBuilderFactory.TahuEdgeEndpointBuilder metricDataTypePayloadMap(String metricDataTypePayloadMap)
      Tahu SparkplugBPayloadMap to configure metric data types for this edge node or device. Note that this payload is used exclusively as a Sparkplug B spec-compliant configuration for all possible edge node or device metric names, aliases, and data types. This configuration is required to publish proper Sparkplug B NBIRTH and DBIRTH payloads. The option will be converted to a org.eclipse.tahu.message.model.SparkplugBPayloadMap type. Required: true Group: producer
      Parameters:
      metricDataTypePayloadMap - the value to set
      Returns:
      the dsl builder

    • deviceIds

      default TahuEdgeEndpointBuilderFactory.TahuEdgeEndpointBuilder deviceIds(String deviceIds)
      ID of each device connected to this edge node, as a comma-separated list. The option is a: java.lang.String type. Group: producer (edge node only)
      Parameters:
      deviceIds - the value to set
      Returns:
      the dsl builder

    • primaryHostId

      default TahuEdgeEndpointBuilderFactory.TahuEdgeEndpointBuilder primaryHostId(String primaryHostId)
      Host ID of the primary host application for this edge node. The option is a: java.lang.String type. Group: producer (edge node only)
      Parameters:
      primaryHostId - the value to set
      Returns:
      the dsl builder

    • password

      default TahuEdgeEndpointBuilderFactory.TahuEdgeEndpointBuilder password(String password)
      Password for MQTT server authentication. The option is a: java.lang.String type. Group: security
      Parameters:
      password - the value to set
      Returns:
      the dsl builder

    • sslContextParameters

      default TahuEdgeEndpointBuilderFactory.TahuEdgeEndpointBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
      SSL configuration for MQTT server connections. The option is a: org.apache.camel.support.jsse.SSLContextParameters type. Group: security
      Parameters:
      sslContextParameters - the value to set
      Returns:
      the dsl builder

    • sslContextParameters

      default TahuEdgeEndpointBuilderFactory.TahuEdgeEndpointBuilder sslContextParameters(String sslContextParameters)
      SSL configuration for MQTT server connections. The option will be converted to a org.apache.camel.support.jsse.SSLContextParameters type. Group: security
      Parameters:
      sslContextParameters - the value to set
      Returns:
      the dsl builder

    • username

      default TahuEdgeEndpointBuilderFactory.TahuEdgeEndpointBuilder username(String username)
      Username for MQTT server authentication. The option is a: java.lang.String type. Group: security
      Parameters:
      username - the value to set
      Returns:
      the dsl builder