Class Right

java.lang.Object
com.sap.ai.sdk.grounding.model.Right

public class Right extends Object
Right
  • Constructor Details

    • Right

      protected Right()
      Default constructor for Right.
  • Method Details

    • operator

      @Nonnull public Right operator(@Nonnull Right.OperatorEnum operator)
      Set the operator of this Right instance and return the same instance.
      Parameters:
      operator - The operator of this Right
      Returns:
      The same instance of this Right class
    • getOperator

      @Nonnull public Right.OperatorEnum getOperator()
      Get operator
      Returns:
      operator The operator of this Right instance.
    • setOperator

      public void setOperator(@Nonnull Right.OperatorEnum operator)
      Set the operator of this Right instance.
      Parameters:
      operator - The operator of this Right
    • left

      @Nonnull public Right left(@Nonnull Left left)
      Set the left of this Right instance and return the same instance.
      Parameters:
      left - The left of this Right
      Returns:
      The same instance of this Right class
    • getLeft

      @Nonnull public Left getLeft()
      Get left
      Returns:
      left The left of this Right instance.
    • setLeft

      public void setLeft(@Nonnull Left left)
      Set the left of this Right instance.
      Parameters:
      left - The left of this Right
    • right

      @Nonnull public Right right(@Nonnull Right right)
      Set the right of this Right instance and return the same instance.
      Parameters:
      right - The right of this Right
      Returns:
      The same instance of this Right class
    • getRight

      @Nonnull public Right getRight()
      Get right
      Returns:
      right The right of this Right instance.
    • setRight

      public void setRight(@Nonnull Right right)
      Set the right of this Right instance.
      Parameters:
      right - The right of this Right
    • key

      @Nonnull public Right key(@Nonnull String key)
      Set the key of this Right instance and return the same instance.
      Parameters:
      key - The key of this Right
      Returns:
      The same instance of this Right class
    • getKey

      @Nonnull public String getKey()
      Get key
      Returns:
      key The key of this Right instance.
    • setKey

      public void setKey(@Nonnull String key)
      Set the key of this Right instance.
      Parameters:
      key - The key of this Right
    • value

      @Nonnull public Right value(@Nonnull List<String> value)
      Set the value of this Right instance and return the same instance.
      Parameters:
      value - The value of this Right
      Returns:
      The same instance of this Right class
    • addValueItem

      @Nonnull public Right addValueItem(@Nonnull String valueItem)
      Add one value instance to this Right.
      Parameters:
      valueItem - The value that should be added
      Returns:
      The same instance of type Right
    • getValue

      @Nonnull public List<String> getValue()
      Get value
      Returns:
      value The value of this Right instance.
    • setValue

      public void setValue(@Nonnull List<String> value)
      Set the value of this Right instance.
      Parameters:
      value - The value of this Right
    • scope

      @Nonnull public Right scope(@Nullable Right.ScopeEnum scope)
      Set the scope of this Right instance and return the same instance.
      Parameters:
      scope - The scope of this Right
      Returns:
      The same instance of this Right class
    • getScope

      @Nonnull public Right.ScopeEnum getScope()
      Get scope
      Returns:
      scope The scope of this Right instance.
    • setScope

      public void setScope(@Nullable Right.ScopeEnum scope)
      Set the scope of this Right instance.
      Parameters:
      scope - The scope of this Right
    • getCustomFieldNames

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