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

Class TrckLabel

java.lang.Object
com.sap.ai.sdk.core.model.TrckLabel
public class TrckLabel extends Object
a classifying phrase/name applied to a metric

  • Constructor Details

    • TrckLabel

      protected TrckLabel()
      Default constructor for TrckLabel.

  • Method Details

    • name

      @Nonnull public TrckLabel name(@Nonnull String name)
      Set the name of this TrckLabel instance and return the same instance.
      Parameters:
      name - Label name to label one or more metrics. \"metrics.ai.sap.com/Artifact.name\" is a reserved label to associate an artifact with the metrics
      Returns:
      The same instance of this TrckLabel class

    • getName

      @Nonnull public String getName()
      Label name to label one or more metrics. \"metrics.ai.sap.com/Artifact.name\" is a reserved label to associate an artifact with the metrics
      Returns:
      name The name of this TrckLabel instance.

    • setName

      public void setName(@Nonnull String name)
      Set the name of this TrckLabel instance.
      Parameters:
      name - Label name to label one or more metrics. \"metrics.ai.sap.com/Artifact.name\" is a reserved label to associate an artifact with the metrics

    • value

      @Nonnull public TrckLabel value(@Nonnull String value)
      Set the value of this TrckLabel instance and return the same instance.
      Parameters:
      value - Metric Label Value
      Returns:
      The same instance of this TrckLabel class

    • getValue

      @Nonnull public String getValue()
      Metric Label Value
      Returns:
      value The value of this TrckLabel instance.

    • setValue

      public void setValue(@Nonnull String value)
      Set the value of this TrckLabel instance.
      Parameters:
      value - Metric Label Value

    • getCustomFieldNames

      @Nonnull public Set<String> getCustomFieldNames()
      Get the names of the unrecognizable properties of the TrckLabel.
      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 TrckLabel 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 TrckLabel 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 TrckLabel 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 TrckLabel.Builder create()
      Create a type-safe, fluent-api builder object to construct a new TrckLabel instance with all required arguments.