Class GenericModuleResult

java.lang.Object
com.sap.ai.sdk.orchestration.model.GenericModuleResult

public class GenericModuleResult extends Object
Generic module result
  • Constructor Details

    • GenericModuleResult

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

    • message

      @Nonnull public GenericModuleResult message(@Nonnull String message)
      Set the message of this GenericModuleResult instance and return the same instance.
      Parameters:
      message - Some message created from the module
      Returns:
      The same instance of this GenericModuleResult class
    • getMessage

      @Nonnull public String getMessage()
      Some message created from the module
      Returns:
      message The message of this GenericModuleResult instance.
    • setMessage

      public void setMessage(@Nonnull String message)
      Set the message of this GenericModuleResult instance.
      Parameters:
      message - Some message created from the module
    • data

      @Nonnull public GenericModuleResult data(@Nullable Object data)
      Set the data of this GenericModuleResult instance and return the same instance.
      Parameters:
      data - Additional data object from the module
      Returns:
      The same instance of this GenericModuleResult class
    • getData

      @Nonnull public Object getData()
      Additional data object from the module
      Returns:
      data The data of this GenericModuleResult instance.
    • setData

      public void setData(@Nullable Object data)
      Set the data of this GenericModuleResult instance.
      Parameters:
      data - Additional data object from the module
    • getCustomFieldNames

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