io.vertx.kafka.admin

## Class ConfigSynonym

- java.lang.Object
- - io.vertx.kafka.admin.ConfigSynonym

-     public class ConfigSynonym
      extends Object

  Class representing a configuration synonym of a `ConfigEntry`

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `ConfigSynonym()` Constructor
    `ConfigSynonym(JsonObject json)` Constructor (from JSON representation)
    `ConfigSynonym(String name, String value, org.apache.kafka.clients.admin.ConfigEntry.ConfigSource source)` Constructor

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getName()`
    `org.apache.kafka.clients.admin.ConfigEntry.ConfigSource` | `getSource()`
    `String` | `getValue()`
    `ConfigSynonym` | `setName(String name)` Set the name of this configuration
    `ConfigSynonym` | `setSource(org.apache.kafka.clients.admin.ConfigEntry.ConfigSource source)` Set the source of this configuration
    `ConfigSynonym` | `setValue(String value)` Set the value of this configuration, which may be null if the configuration is sensitive
    `JsonObject` | `toJson()` Convert object to JSON representation
    `String` | `toString()`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### ConfigSynonym

          public ConfigSynonym()

      Constructor

    - #### ConfigSynonym

          public ConfigSynonym(String name,
                               String value,
                               org.apache.kafka.clients.admin.ConfigEntry.ConfigSource source)

      Constructor
      Parameters:
        `name` - the name of this configuration
        `value` - the value of this configuration, which may be null if the configuration is sensitive
        `source` - the source of this configuration

    - #### ConfigSynonym

          public ConfigSynonym(JsonObject json)

      Constructor (from JSON representation)
      Parameters:
        `json` - JSON representation

  - ### Method Detail

    - #### getName

          public String getName()

      Returns:
        the name of this configuration

    - #### setName

          public ConfigSynonym setName(String name)

      Set the name of this configuration
      Parameters:
        `name` - the name of this configuration
      Returns:
        current instance of the class to be fluent

    - #### getValue

          public String getValue()

      Returns:
        the value of this configuration, which may be null if the configuration is sensitive

    - #### setValue

          public ConfigSynonym setValue(String value)

      Set the value of this configuration, which may be null if the configuration is sensitive
      Parameters:
        `value` - the value of this configuration, which may be null if the configuration is sensitive
      Returns:
        current instance of the class to be fluent

    - #### getSource

          public org.apache.kafka.clients.admin.ConfigEntry.ConfigSource getSource()

      Returns:
        the source of this configuration

    - #### setSource

          public ConfigSynonym setSource(org.apache.kafka.clients.admin.ConfigEntry.ConfigSource source)

      Set the source of this configuration
      Parameters:
        `source` - the source of this configuration
      Returns:
        current instance of the class to be fluent

    - #### toJson

          public JsonObject toJson()

      Convert object to JSON representation
      Returns:
        JSON representation

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

Copyright © 2023 Eclipse. All rights reserved.