Package com.sap.ai.sdk.prompt.registry.model

Class TemplateRef

java.lang.Object
com.sap.ai.sdk.prompt.registry.model.TemplateRef
All Implemented Interfaces:
PromptTemplatingModuleConfigPrompt
public class TemplateRef extends Object implements PromptTemplatingModuleConfigPrompt
TemplateRef

  • Constructor Details

    • TemplateRef

      protected TemplateRef()
      Default constructor for TemplateRef.

  • Method Details

    • templateRef

      @Nonnull public TemplateRef templateRef(@Nonnull TemplateRefTemplateRef templateRef)
      Set the templateRef of this TemplateRef instance and return the same instance.
      Parameters:
      templateRef - The templateRef of this TemplateRef
      Returns:
      The same instance of this TemplateRef class

    • getTemplateRef

      @Nonnull public TemplateRefTemplateRef getTemplateRef()
      Get templateRef
      Returns:
      templateRef The templateRef of this TemplateRef instance.

    • setTemplateRef

      public void setTemplateRef(@Nonnull TemplateRefTemplateRef templateRef)
      Set the templateRef of this TemplateRef instance.
      Parameters:
      templateRef - The templateRef of this TemplateRef

    • getCustomFieldNames

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