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

Class TemplateRefByID

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

  • Constructor Details

    • TemplateRefByID

      protected TemplateRefByID()
      Default constructor for TemplateRefByID.

  • Method Details

    • id

      @Nonnull public TemplateRefByID id(@Nonnull String id)
      Set the id of this TemplateRefByID instance and return the same instance.
      Parameters:
      id - ID of the template in prompt registry
      Returns:
      The same instance of this TemplateRefByID class

    • getId

      @Nonnull public String getId()
      ID of the template in prompt registry
      Returns:
      id The id of this TemplateRefByID instance.

    • setId

      public void setId(@Nonnull String id)
      Set the id of this TemplateRefByID instance.
      Parameters:
      id - ID of the template in prompt registry

    • scope

      @Nonnull public TemplateRefByID scope(@Nullable TemplateRefByID.ScopeEnum scope)
      Set the scope of this TemplateRefByID instance and return the same instance.
      Parameters:
      scope - Defines the scope that is searched for the referenced template. 'tenant' indicates the template is shared across all resource groups within the tenant, while 'resource_group' indicates the template is only accessible within the specific resource group.
      Returns:
      The same instance of this TemplateRefByID class

    • getScope

      @Nonnull public TemplateRefByID.ScopeEnum getScope()
      Defines the scope that is searched for the referenced template. 'tenant' indicates the template is shared across all resource groups within the tenant, while 'resource_group' indicates the template is only accessible within the specific resource group.
      Returns:
      scope The scope of this TemplateRefByID instance.

    • setScope

      public void setScope(@Nullable TemplateRefByID.ScopeEnum scope)
      Set the scope of this TemplateRefByID instance.
      Parameters:
      scope - Defines the scope that is searched for the referenced template. 'tenant' indicates the template is shared across all resource groups within the tenant, while 'resource_group' indicates the template is only accessible within the specific resource group.

    • getCustomFieldNames

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