Package org.apache.iotdb.pipe.api.customizer.parameter

Class PipeParameters

java.lang.Object
org.apache.iotdb.pipe.api.customizer.parameter.PipeParameters
public class PipeParameters extends Object
Used in PipeExtractor.customize(PipeParameters, PipeExtractorRuntimeConfiguration) , PipeProcessor.customize(PipeParameters, PipeProcessorRuntimeConfiguration) and PipeConnector.customize(PipeParameters, PipeConnectorRuntimeConfiguration).

This class is used to parse the parameters in WITH SOURCE, WITH PROCESSOR and WITH SINK when creating a pipe.

The input parameters are the key-value pair attributes for customization.

  • Field Details

  • Constructor Details

  • Method Details

    • getAttribute

      public Map<String,String> getAttribute()

    • hasAttribute

      public boolean hasAttribute(String key)

    • hasAnyAttributes

      public boolean hasAnyAttributes(String... keys)

    • addAttribute

      public void addAttribute(String key, String values)

    • computeAttributeIfExists

      public void computeAttributeIfExists(BiFunction<String,String,String> valueComputer, String... keys)

    • getString

      public String getString(String key)

    • getBoolean

      public Boolean getBoolean(String key)

    • getInt

      public Integer getInt(String key)

    • getLong

      public Long getLong(String key)

    • getFloat

      public Float getFloat(String key)

    • getDouble

      public Double getDouble(String key)

    • getStringByKeys

      public String getStringByKeys(String... keys)

    • getBooleanByKeys

      public Boolean getBooleanByKeys(String... keys)

    • getIntByKeys

      public Integer getIntByKeys(String... keys)

    • getLongByKeys

      public Long getLongByKeys(String... keys)

    • getFloatByKeys

      public Float getFloatByKeys(String... keys)

    • getDoubleByKeys

      public Double getDoubleByKeys(String... keys)

    • getStringOrDefault

      public String getStringOrDefault(String key, String defaultValue)

    • getBooleanOrDefault

      public boolean getBooleanOrDefault(String key, boolean defaultValue)

    • getIntOrDefault

      public int getIntOrDefault(String key, int defaultValue)

    • getLongOrDefault

      public long getLongOrDefault(String key, long defaultValue)

    • getFloatOrDefault

      public float getFloatOrDefault(String key, float defaultValue)

    • getDoubleOrDefault

      public double getDoubleOrDefault(String key, double defaultValue)

    • getStringOrDefault

      public String getStringOrDefault(List<String> keys, String defaultValue)

    • getBooleanOrDefault

      public boolean getBooleanOrDefault(List<String> keys, boolean defaultValue)

    • getIntOrDefault

      public int getIntOrDefault(List<String> keys, int defaultValue)

    • getLongOrDefault

      public long getLongOrDefault(List<String> keys, long defaultValue)

    • getFloatOrDefault

      public float getFloatOrDefault(List<String> keys, float defaultValue)

    • getDoubleOrDefault

      public double getDoubleOrDefault(List<String> keys, double defaultValue)

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      When exposing the content of this `PipeParameters` to external sources (such as `show pipes` or logging), please use this `toString` method to prevent the leakage of private information.
      Overrides:
      toString in class Object

    • addOrReplaceEquivalentAttributes

      public PipeParameters addOrReplaceEquivalentAttributes(PipeParameters that)
      This method adds (non-existed) or replaces (existed) equivalent attributes in this PipeParameters with those from another PipeParameters.
      Parameters:
      that - provide the key that needs to be updated along with the value
      Returns:
      this pipe parameters

    • addOrReplaceEquivalentAttributesWithClone

      public PipeParameters addOrReplaceEquivalentAttributesWithClone(PipeParameters that)
      This method clones a new PipeParameters with equivalent attributes in this PipeParameters added by (non-existed) or replaces with (existed) those from another PipeParameters.
      Parameters:
      that - provide the key that needs to be updated along with the value
      Returns:
      this PipeParameters