Package com.sap.ai.sdk.core.model

Class TrckTag

java.lang.Object
com.sap.ai.sdk.core.model.TrckTag
public class TrckTag extends Object
A dictionary of name-value pairs to support segregation at execution level.

  • Constructor Details

    • TrckTag

      protected TrckTag()
      Default constructor for TrckTag.

  • Method Details

    • name

      @Nonnull public TrckTag name(@Nonnull String name)
      Set the name of this TrckTag instance and return the same instance.
      Parameters:
      name - Generic name which can belong to a tag,label,metric or customInfo Object
      Returns:
      The same instance of this TrckTag class

    • getName

      @Nonnull public String getName()
      Generic name which can belong to a tag,label,metric or customInfo Object
      Returns:
      name The name of this TrckTag instance.

    • setName

      public void setName(@Nonnull String name)
      Set the name of this TrckTag instance.
      Parameters:
      name - Generic name which can belong to a tag,label,metric or customInfo Object

    • value

      @Nonnull public TrckTag value(@Nonnull String value)
      Set the value of this TrckTag instance and return the same instance.
      Parameters:
      value - tag value
      Returns:
      The same instance of this TrckTag class

    • getValue

      @Nonnull public String getValue()
      tag value
      Returns:
      value The value of this TrckTag instance.

    • setValue

      public void setValue(@Nonnull String value)
      Set the value of this TrckTag instance.
      Parameters:
      value - tag value

    • getCustomFieldNames

      @Nonnull public Set<String> getCustomFieldNames()
      Get the names of the unrecognizable properties of the TrckTag.
      Returns:
      The set of properties names

    • getCustomField

      @Nullable @Deprecated public Object getCustomField(@Nonnull String name) throws NoSuchElementException
      Deprecated.
      Use toMap() instead.
      Get the value of an unrecognizable property of this TrckTag instance.
      Parameters:
      name - The name of the property
      Returns:
      The value of the property
      Throws:
      NoSuchElementException - If no property with the given name could be found.

    • toMap

      @Nonnull public Map<String,Object> toMap()
      Get the value of all properties of this TrckTag instance including unrecognized properties.
      Returns:
      The map of all properties

    • setCustomField

      public void setCustomField(@Nonnull String customFieldName, @Nullable Object customFieldValue)
      Set an unrecognizable property of this TrckTag instance. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      customFieldName - The name of the property
      customFieldValue - The value of the property

    • equals

      public boolean equals(@Nullable Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      @Nonnull public String toString()
      Overrides:
      toString in class Object

    • create

      public static TrckTag.Builder create()
      Create a type-safe, fluent-api builder object to construct a new TrckTag instance with all required arguments.