Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 83271200D2F for ; Wed, 1 Nov 2017 14:28:25 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 81A5F160C0A; Wed, 1 Nov 2017 13:28:25 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 8A09E160BEA for ; Wed, 1 Nov 2017 14:28:18 +0100 (CET) Received: (qmail 74659 invoked by uid 500); 1 Nov 2017 13:28:17 -0000 Mailing-List: contact commits-help@kafka.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@kafka.apache.org Delivered-To: mailing list commits@kafka.apache.org Received: (qmail 74649 invoked by uid 99); 1 Nov 2017 13:28:17 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 01 Nov 2017 13:28:17 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 04DF2DFCF9; Wed, 1 Nov 2017 13:28:14 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: ijuma@apache.org To: commits@kafka.apache.org Date: Wed, 01 Nov 2017 13:28:28 -0000 Message-Id: <75b8f78d416747469caea2bd48ddcd5b@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [15/51] [partial] kafka-site git commit: Add Javadoc for 1.0.0 archived-at: Wed, 01 Nov 2017 13:28:25 -0000 http://git-wip-us.apache.org/repos/asf/kafka-site/blob/6050b147/100/javadoc/org/apache/kafka/common/config/ConfigDef.html ---------------------------------------------------------------------- diff --git a/100/javadoc/org/apache/kafka/common/config/ConfigDef.html b/100/javadoc/org/apache/kafka/common/config/ConfigDef.html new file mode 100644 index 0000000..38fcb62 --- /dev/null +++ b/100/javadoc/org/apache/kafka/common/config/ConfigDef.html @@ -0,0 +1,1448 @@ + + + + + +ConfigDef (kafka 1.0.0 API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.apache.kafka.common.config
+

Class ConfigDef

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.apache.kafka.common.config.ConfigDef
      • +
    +
    • +
+
+
    +
  • +
    +
    +
    public class ConfigDef
+extends java.lang.Object
    +
    This class is used for specifying the set of expected configurations. For each configuration, you can specify + the name, the type, the default value, the documentation, the group information, the order in the group, + the width of the configuration value and the name suitable for display in the UI. + + You can provide special validation logic used for single configuration validation by overriding ConfigDef.Validator. + + Moreover, you can specify the dependents of a configuration. The valid values and visibility of a configuration + may change according to the values of other configurations. You can override ConfigDef.Recommender to get valid + values and set visibility of a configuration given the current configuration values. + +

    + To use the class: +

    + 

    + ConfigDef defs = new ConfigDef();
+
+ defs.define("config_with_default", Type.STRING, "default string value", "Configuration with default value.");
+ defs.define("config_with_validator", Type.INT, 42, Range.atLeast(0), "Configuration with user provided validator.");
+ defs.define("config_with_dependents", Type.INT, "Configuration with dependents.", "group", 1, "Config With Dependents", Arrays.asList("config_with_default","config_with_validator"));
+
+ Map<String, String> props = new HashMap<>();
+ props.put("config_with_default", "some value");
+ props.put("config_with_dependents", "some other value");
+ 
+ Map<String, Object> configs = defs.parse(props);
+ // will return "some value"
+ String someConfig = (String) configs.get("config_with_default");
+ // will return default value of 42
+ int anotherConfig = (Integer) configs.get("config_with_validator");
+
+ To validate the full configuration, use:
+ List<Config> configs = defs.validate(props);
+ The Config contains updated configuration information given the current configuration values.
+
    +

    + This class can be used standalone or in combination with AbstractConfig which provides some additional + functionality for accessing configs.

    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.lang.ObjectNO_DEFAULT_VALUE +
      A unique Java object which represents the lack of a default value.
      +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.util.Map<java.lang.String,ConfigDef.ConfigKey>configKeys() +
      Get the configuration keys
      +
      static java.lang.StringconvertToString(java.lang.Object parsedValue, + ConfigDef.Type type) 
      ConfigDefdefine(ConfigDef.ConfigKey key) 
      ConfigDefdefine(java.lang.String name, + ConfigDef.Type type, + ConfigDef.Importance importance, + java.lang.String documentation) +
      Define a new configuration with no default value and no special validation logic
      +
      ConfigDefdefine(java.lang.String name, + ConfigDef.Type type, + ConfigDef.Importance importance, + java.lang.String documentation, + java.lang.String group, + int orderInGroup, + ConfigDef.Width width, + java.lang.String displayName) +
      Define a new configuration with no default value, no special validation logic, no dependents and no custom recommender
      +
      ConfigDefdefine(java.lang.String name, + ConfigDef.Type type, + ConfigDef.Importance importance, + java.lang.String documentation, + java.lang.String group, + int orderInGroup, + ConfigDef.Width width, + java.lang.String displayName, + ConfigDef.Recommender recommender) +
      Define a new configuration with no default value, no special validation logic and no custom recommender
      +
      ConfigDefdefine(java.lang.String name, + ConfigDef.Type type, + ConfigDef.Importance importance, + java.lang.String documentation, + java.lang.String group, + int orderInGroup, + ConfigDef.Width width, + java.lang.String displayName, + java.util.List<java.lang.String> dependents) +
      Define a new configuration with no default value, no special validation logic and no custom recommender
      +
      ConfigDefdefine(java.lang.String name, + ConfigDef.Type type, + ConfigDef.Importance importance, + java.lang.String documentation, + java.lang.String group, + int orderInGroup, + ConfigDef.Width width, + java.lang.String displayName, + java.util.List<java.lang.String> dependents, + ConfigDef.Recommender recommender) +
      Define a new configuration with no default value and no special validation logic
      +
      ConfigDefdefine(java.lang.String name, + ConfigDef.Type type, + java.lang.Object defaultValue, + ConfigDef.Importance importance, + java.lang.String documentation) +
      Define a new configuration with no special validation logic
      +
      ConfigDefdefine(java.lang.String name, + ConfigDef.Type type, + java.lang.Object defaultValue, + ConfigDef.Importance importance, + java.lang.String documentation, + java.lang.String group, + int orderInGroup, + ConfigDef.Width width, + java.lang.String displayName) +
      Define a new configuration with no special validation logic, not dependents and no custom recommender
      +
      ConfigDefdefine(java.lang.String name, + ConfigDef.Type type, + java.lang.Object defaultValue, + ConfigDef.Importance importance, + java.lang.String documentation, + java.lang.String group, + int orderInGroup, + ConfigDef.Width width, + java.lang.String displayName, + ConfigDef.Recommender recommender) +
      Define a new configuration with no special validation logic and no custom recommender
      +
      ConfigDefdefine(java.lang.String name, + ConfigDef.Type type, + java.lang.Object defaultValue, + ConfigDef.Importance importance, + java.lang.String documentation, + java.lang.String group, + int orderInGroup, + ConfigDef.Width width, + java.lang.String displayName, + java.util.List<java.lang.String> dependents) +
      Define a new configuration with no special validation logic and no custom recommender
      +
      ConfigDefdefine(java.lang.String name, + ConfigDef.Type type, + java.lang.Object defaultValue, + ConfigDef.Importance importance, + java.lang.String documentation, + java.lang.String group, + int orderInGroup, + ConfigDef.Width width, + java.lang.String displayName, + java.util.List<java.lang.String> dependents, + ConfigDef.Recommender recommender) +
      Define a new configuration with no special validation logic
      +
      ConfigDefdefine(java.lang.String name, + ConfigDef.Type type, + java.lang.Object defaultValue, + ConfigDef.Validator validator, + ConfigDef.Importance importance, + java.lang.String documentation) +
      Define a new configuration with no group, no order in group, no width, no display name, no dependents and no custom recommender
      +
      ConfigDefdefine(java.lang.String name, + ConfigDef.Type type, + java.lang.Object defaultValue, + ConfigDef.Validator validator, + ConfigDef.Importance importance, + java.lang.String documentation, + java.lang.String group, + int orderInGroup, + ConfigDef.Width width, + java.lang.String displayName) +
      Define a new configuration with no dependents and no custom recommender
      +
      ConfigDefdefine(java.lang.String name, + ConfigDef.Type type, + java.lang.Object defaultValue, + ConfigDef.Validator validator, + ConfigDef.Importance importance, + java.lang.String documentation, + java.lang.String group, + int orderInGroup, + ConfigDef.Width width, + java.lang.String displayName, + ConfigDef.Recommender recommender) +
      Define a new configuration with no dependents
      +
      ConfigDefdefine(java.lang.String name, + ConfigDef.Type type, + java.lang.Object defaultValue, + ConfigDef.Validator validator, + ConfigDef.Importance importance, + java.lang.String documentation, + java.lang.String group, + int orderInGroup, + ConfigDef.Width width, + java.lang.String displayName, + java.util.List<java.lang.String> dependents) +
      Define a new configuration with no custom recommender
      +
      ConfigDefdefine(java.lang.String name, + ConfigDef.Type type, + java.lang.Object defaultValue, + ConfigDef.Validator validator, + ConfigDef.Importance importance, + java.lang.String documentation, + java.lang.String group, + int orderInGroup, + ConfigDef.Width width, + java.lang.String displayName, + java.util.List<java.lang.String> dependents, + ConfigDef.Recommender recommender) +
      Define a new configuration
      +
      ConfigDefdefineInternal(java.lang.String name, + ConfigDef.Type type, + java.lang.Object defaultValue, + ConfigDef.Importance importance) +
      Define a new internal configuration.
      +
      voidembed(java.lang.String keyPrefix, + java.lang.String groupPrefix, + int startingOrd, + ConfigDef child) 
      protected java.lang.StringgetConfigValue(ConfigDef.ConfigKey key, + java.lang.String headerName) 
      java.util.List<java.lang.String>groups() +
      Get the groups for the configuration
      +
      protected java.util.List<java.lang.String>headers() 
      java.util.Set<java.lang.String>names() +
      Returns unmodifiable set of properties names defined in this ConfigDef
      +
      java.util.Map<java.lang.String,java.lang.Object>parse(java.util.Map<?,?> props) +
      Parse and validate configs against this configuration definition.
      +
      static java.lang.ObjectparseType(java.lang.String name, + java.lang.Object value, + ConfigDef.Type type) +
      Parse a value according to its expected type.
      +
      java.lang.StringtoEnrichedRst() +
      Configs with new metadata (group, orderInGroup, dependents) formatted with reStructuredText, suitable for embedding in Sphinx + documentation.
      +
      java.lang.StringtoHtmlTable() 
      java.lang.StringtoRst() +
      Get the configs formatted with reStructuredText, suitable for embedding in Sphinx + documentation.
      +
      java.util.List<ConfigValue>validate(java.util.Map<java.lang.String,java.lang.String> props) +
      Validate the current configuration values with the configuration definition.
      +
      java.util.Map<java.lang.String,ConfigValue>validateAll(java.util.Map<java.lang.String,java.lang.String> props) 
      ConfigDefwithClientSaslSupport() +
      Add standard SASL client configuration options.
      +
      ConfigDefwithClientSslSupport() +
      Add standard SSL client configuration options.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        NO_DEFAULT_VALUE

        +
        public static final java.lang.Object NO_DEFAULT_VALUE
        +
        A unique Java object which represents the lack of a default value.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConfigDef

        +
        public ConfigDef()
        +
        • +
      + + + +
        +
      • +

        ConfigDef

        +
        public ConfigDef(ConfigDef base)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        names

        +
        public java.util.Set<java.lang.String> names()
        +
        Returns unmodifiable set of properties names defined in this ConfigDef
        +
        +
        Returns:
        +
        new unmodifiable Set instance containing the keys
        +
        +
        • +
      + + + + + + + +
        +
      • +

        define

        +
        public ConfigDef define(java.lang.String name,
+                        ConfigDef.Type type,
+                        java.lang.Object defaultValue,
+                        ConfigDef.Validator validator,
+                        ConfigDef.Importance importance,
+                        java.lang.String documentation,
+                        java.lang.String group,
+                        int orderInGroup,
+                        ConfigDef.Width width,
+                        java.lang.String displayName,
+                        java.util.List<java.lang.String> dependents,
+                        ConfigDef.Recommender recommender)
        +
        Define a new configuration
        +
        +
        Parameters:
        +
        name - the name of the config parameter
        +
        type - the type of the config
        +
        defaultValue - the default value to use if this config isn't present
        +
        validator - the validator to use in checking the correctness of the config
        +
        importance - the importance of this config
        +
        documentation - the documentation string for the config
        +
        group - the group this config belongs to
        +
        orderInGroup - the order of this config in the group
        +
        width - the width of the config
        +
        displayName - the name suitable for display
        +
        dependents - the configurations that are dependents of this configuration
        +
        recommender - the recommender provides valid values given the parent configuration values
        +
        Returns:
        +
        This ConfigDef so you can chain calls
        +
        +
        • +
      + + + +
        +
      • +

        define

        +
        public ConfigDef define(java.lang.String name,
+                        ConfigDef.Type type,
+                        java.lang.Object defaultValue,
+                        ConfigDef.Validator validator,
+                        ConfigDef.Importance importance,
+                        java.lang.String documentation,
+                        java.lang.String group,
+                        int orderInGroup,
+                        ConfigDef.Width width,
+                        java.lang.String displayName,
+                        java.util.List<java.lang.String> dependents)
        +
        Define a new configuration with no custom recommender
        +
        +
        Parameters:
        +
        name - the name of the config parameter
        +
        type - the type of the config
        +
        defaultValue - the default value to use if this config isn't present
        +
        validator - the validator to use in checking the correctness of the config
        +
        importance - the importance of this config
        +
        documentation - the documentation string for the config
        +
        group - the group this config belongs to
        +
        orderInGroup - the order of this config in the group
        +
        width - the width of the config
        +
        displayName - the name suitable for display
        +
        dependents - the configurations that are dependents of this configuration
        +
        Returns:
        +
        This ConfigDef so you can chain calls
        +
        +
        • +
      + + + +
        +
      • +

        define

        +
        public ConfigDef define(java.lang.String name,
+                        ConfigDef.Type type,
+                        java.lang.Object defaultValue,
+                        ConfigDef.Validator validator,
+                        ConfigDef.Importance importance,
+                        java.lang.String documentation,
+                        java.lang.String group,
+                        int orderInGroup,
+                        ConfigDef.Width width,
+                        java.lang.String displayName,
+                        ConfigDef.Recommender recommender)
        +
        Define a new configuration with no dependents
        +
        +
        Parameters:
        +
        name - the name of the config parameter
        +
        type - the type of the config
        +
        defaultValue - the default value to use if this config isn't present
        +
        validator - the validator to use in checking the correctness of the config
        +
        importance - the importance of this config
        +
        documentation - the documentation string for the config
        +
        group - the group this config belongs to
        +
        orderInGroup - the order of this config in the group
        +
        width - the width of the config
        +
        displayName - the name suitable for display
        +
        recommender - the recommender provides valid values given the parent configuration values
        +
        Returns:
        +
        This ConfigDef so you can chain calls
        +
        +
        • +
      + + + +
        +
      • +

        define

        +
        public ConfigDef define(java.lang.String name,
+                        ConfigDef.Type type,
+                        java.lang.Object defaultValue,
+                        ConfigDef.Validator validator,
+                        ConfigDef.Importance importance,
+                        java.lang.String documentation,
+                        java.lang.String group,
+                        int orderInGroup,
+                        ConfigDef.Width width,
+                        java.lang.String displayName)
        +
        Define a new configuration with no dependents and no custom recommender
        +
        +
        Parameters:
        +
        name - the name of the config parameter
        +
        type - the type of the config
        +
        defaultValue - the default value to use if this config isn't present
        +
        validator - the validator to use in checking the correctness of the config
        +
        importance - the importance of this config
        +
        documentation - the documentation string for the config
        +
        group - the group this config belongs to
        +
        orderInGroup - the order of this config in the group
        +
        width - the width of the config
        +
        displayName - the name suitable for display
        +
        Returns:
        +
        This ConfigDef so you can chain calls
        +
        +
        • +
      + + + +
        +
      • +

        define

        +
        public ConfigDef define(java.lang.String name,
+                        ConfigDef.Type type,
+                        java.lang.Object defaultValue,
+                        ConfigDef.Importance importance,
+                        java.lang.String documentation,
+                        java.lang.String group,
+                        int orderInGroup,
+                        ConfigDef.Width width,
+                        java.lang.String displayName,
+                        java.util.List<java.lang.String> dependents,
+                        ConfigDef.Recommender recommender)
        +
        Define a new configuration with no special validation logic
        +
        +
        Parameters:
        +
        name - the name of the config parameter
        +
        type - the type of the config
        +
        defaultValue - the default value to use if this config isn't present
        +
        importance - the importance of this config
        +
        documentation - the documentation string for the config
        +
        group - the group this config belongs to
        +
        orderInGroup - the order of this config in the group
        +
        width - the width of the config
        +
        displayName - the name suitable for display
        +
        dependents - the configurations that are dependents of this configuration
        +
        recommender - the recommender provides valid values given the parent configuration values
        +
        Returns:
        +
        This ConfigDef so you can chain calls
        +
        +
        • +
      + + + +
        +
      • +

        define

        +
        public ConfigDef define(java.lang.String name,
+                        ConfigDef.Type type,
+                        java.lang.Object defaultValue,
+                        ConfigDef.Importance importance,
+                        java.lang.String documentation,
+                        java.lang.String group,
+                        int orderInGroup,
+                        ConfigDef.Width width,
+                        java.lang.String displayName,
+                        java.util.List<java.lang.String> dependents)
        +
        Define a new configuration with no special validation logic and no custom recommender
        +
        +
        Parameters:
        +
        name - the name of the config parameter
        +
        type - the type of the config
        +
        defaultValue - the default value to use if this config isn't present
        +
        importance - the importance of this config
        +
        documentation - the documentation string for the config
        +
        group - the group this config belongs to
        +
        orderInGroup - the order of this config in the group
        +
        width - the width of the config
        +
        displayName - the name suitable for display
        +
        dependents - the configurations that are dependents of this configuration
        +
        Returns:
        +
        This ConfigDef so you can chain calls
        +
        +
        • +
      + + + +
        +
      • +

        define

        +
        public ConfigDef define(java.lang.String name,
+                        ConfigDef.Type type,
+                        java.lang.Object defaultValue,
+                        ConfigDef.Importance importance,
+                        java.lang.String documentation,
+                        java.lang.String group,
+                        int orderInGroup,
+                        ConfigDef.Width width,
+                        java.lang.String displayName,
+                        ConfigDef.Recommender recommender)
        +
        Define a new configuration with no special validation logic and no custom recommender
        +
        +
        Parameters:
        +
        name - the name of the config parameter
        +
        type - the type of the config
        +
        defaultValue - the default value to use if this config isn't present
        +
        importance - the importance of this config
        +
        documentation - the documentation string for the config
        +
        group - the group this config belongs to
        +
        orderInGroup - the order of this config in the group
        +
        width - the width of the config
        +
        displayName - the name suitable for display
        +
        recommender - the recommender provides valid values given the parent configuration values
        +
        Returns:
        +
        This ConfigDef so you can chain calls
        +
        +
        • +
      + + + +
        +
      • +

        define

        +
        public ConfigDef define(java.lang.String name,
+                        ConfigDef.Type type,
+                        java.lang.Object defaultValue,
+                        ConfigDef.Importance importance,
+                        java.lang.String documentation,
+                        java.lang.String group,
+                        int orderInGroup,
+                        ConfigDef.Width width,
+                        java.lang.String displayName)
        +
        Define a new configuration with no special validation logic, not dependents and no custom recommender
        +
        +
        Parameters:
        +
        name - the name of the config parameter
        +
        type - the type of the config
        +
        defaultValue - the default value to use if this config isn't present
        +
        importance - the importance of this config
        +
        documentation - the documentation string for the config
        +
        group - the group this config belongs to
        +
        orderInGroup - the order of this config in the group
        +
        width - the width of the config
        +
        displayName - the name suitable for display
        +
        Returns:
        +
        This ConfigDef so you can chain calls
        +
        +
        • +
      + + + +
        +
      • +

        define

        +
        public ConfigDef define(java.lang.String name,
+                        ConfigDef.Type type,
+                        ConfigDef.Importance importance,
+                        java.lang.String documentation,
+                        java.lang.String group,
+                        int orderInGroup,
+                        ConfigDef.Width width,
+                        java.lang.String displayName,
+                        java.util.List<java.lang.String> dependents,
+                        ConfigDef.Recommender recommender)
        +
        Define a new configuration with no default value and no special validation logic
        +
        +
        Parameters:
        +
        name - the name of the config parameter
        +
        type - the type of the config
        +
        importance - the importance of this config
        +
        documentation - the documentation string for the config
        +
        group - the group this config belongs to
        +
        orderInGroup - the order of this config in the group
        +
        width - the width of the config
        +
        displayName - the name suitable for display
        +
        dependents - the configurations that are dependents of this configuration
        +
        recommender - the recommender provides valid values given the parent configuration value
        +
        Returns:
        +
        This ConfigDef so you can chain calls
        +
        +
        • +
      + + + +
        +
      • +

        define

        +
        public ConfigDef define(java.lang.String name,
+                        ConfigDef.Type type,
+                        ConfigDef.Importance importance,
+                        java.lang.String documentation,
+                        java.lang.String group,
+                        int orderInGroup,
+                        ConfigDef.Width width,
+                        java.lang.String displayName,
+                        java.util.List<java.lang.String> dependents)
        +
        Define a new configuration with no default value, no special validation logic and no custom recommender
        +
        +
        Parameters:
        +
        name - the name of the config parameter
        +
        type - the type of the config
        +
        importance - the importance of this config
        +
        documentation - the documentation string for the config
        +
        group - the group this config belongs to
        +
        orderInGroup - the order of this config in the group
        +
        width - the width of the config
        +
        displayName - the name suitable for display
        +
        dependents - the configurations that are dependents of this configuration
        +
        Returns:
        +
        This ConfigDef so you can chain calls
        +
        +
        • +
      + + + +
        +
      • +

        define

        +
        public ConfigDef define(java.lang.String name,
+                        ConfigDef.Type type,
+                        ConfigDef.Importance importance,
+                        java.lang.String documentation,
+                        java.lang.String group,
+                        int orderInGroup,
+                        ConfigDef.Width width,
+                        java.lang.String displayName,
+                        ConfigDef.Recommender recommender)
        +
        Define a new configuration with no default value, no special validation logic and no custom recommender
        +
        +
        Parameters:
        +
        name - the name of the config parameter
        +
        type - the type of the config
        +
        importance - the importance of this config
        +
        documentation - the documentation string for the config
        +
        group - the group this config belongs to
        +
        orderInGroup - the order of this config in the group
        +
        width - the width of the config
        +
        displayName - the name suitable for display
        +
        recommender - the recommender provides valid values given the parent configuration value
        +
        Returns:
        +
        This ConfigDef so you can chain calls
        +
        +
        • +
      + + + +
        +
      • +

        define

        +
        public ConfigDef define(java.lang.String name,
+                        ConfigDef.Type type,
+                        ConfigDef.Importance importance,
+                        java.lang.String documentation,
+                        java.lang.String group,
+                        int orderInGroup,
+                        ConfigDef.Width width,
+                        java.lang.String displayName)
        +
        Define a new configuration with no default value, no special validation logic, no dependents and no custom recommender
        +
        +
        Parameters:
        +
        name - the name of the config parameter
        +
        type - the type of the config
        +
        importance - the importance of this config
        +
        documentation - the documentation string for the config
        +
        group - the group this config belongs to
        +
        orderInGroup - the order of this config in the group
        +
        width - the width of the config
        +
        displayName - the name suitable for display
        +
        Returns:
        +
        This ConfigDef so you can chain calls
        +
        +
        • +
      + + + +
        +
      • +

        define

        +
        public ConfigDef define(java.lang.String name,
+                        ConfigDef.Type type,
+                        java.lang.Object defaultValue,
+                        ConfigDef.Validator validator,
+                        ConfigDef.Importance importance,
+                        java.lang.String documentation)
        +
        Define a new configuration with no group, no order in group, no width, no display name, no dependents and no custom recommender
        +
        +
        Parameters:
        +
        name - the name of the config parameter
        +
        type - the type of the config
        +
        defaultValue - the default value to use if this config isn't present
        +
        validator - the validator to use in checking the correctness of the config
        +
        importance - the importance of this config
        +
        documentation - the documentation string for the config
        +
        Returns:
        +
        This ConfigDef so you can chain calls
        +
        +
        • +
      + + + +
        +
      • +

        define

        +
        public ConfigDef define(java.lang.String name,
+                        ConfigDef.Type type,
+                        java.lang.Object defaultValue,
+                        ConfigDef.Importance importance,
+                        java.lang.String documentation)
        +
        Define a new configuration with no special validation logic
        +
        +
        Parameters:
        +
        name - The name of the config parameter
        +
        type - The type of the config
        +
        defaultValue - The default value to use if this config isn't present
        +
        importance - The importance of this config: is this something you will likely need to change.
        +
        documentation - The documentation string for the config
        +
        Returns:
        +
        This ConfigDef so you can chain calls
        +
        +
        • +
      + + + +
        +
      • +

        define

        +
        public ConfigDef define(java.lang.String name,
+                        ConfigDef.Type type,
+                        ConfigDef.Importance importance,
+                        java.lang.String documentation)
        +
        Define a new configuration with no default value and no special validation logic
        +
        +
        Parameters:
        +
        name - The name of the config parameter
        +
        type - The type of the config
        +
        importance - The importance of this config: is this something you will likely need to change.
        +
        documentation - The documentation string for the config
        +
        Returns:
        +
        This ConfigDef so you can chain calls
        +
        +
        • +
      + + + +
        +
      • +

        defineInternal

        +
        public ConfigDef defineInternal(java.lang.String name,
+                                ConfigDef.Type type,
+                                java.lang.Object defaultValue,
+                                ConfigDef.Importance importance)
        +
        Define a new internal configuration. Internal configuration won't show up in the docs and aren't + intended for general use.
        +
        +
        Parameters:
        +
        name - The name of the config parameter
        +
        type - The type of the config
        +
        defaultValue - The default value to use if this config isn't present
        +
        importance -
        +
        Returns:
        +
        This ConfigDef so you can chain calls
        +
        +
        • +
      + + + +
        +
      • +

        configKeys

        +
        public java.util.Map<java.lang.String,ConfigDef.ConfigKey> configKeys()
        +
        Get the configuration keys
        +
        +
        Returns:
        +
        a map containing all configuration keys
        +
        +
        • +
      + + + +
        +
      • +

        groups

        +
        public java.util.List<java.lang.String> groups()
        +
        Get the groups for the configuration
        +
        +
        Returns:
        +
        a list of group names
        +
        +
        • +
      + + + +
        +
      • +

        withClientSslSu