Class ToolReference


  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
               date="2026-06-30T13:33:45.929090Z[Etc/UTC]",
               comments="Generator version: 7.18.0")
    public class ToolReference
    extends java.lang.Object
    A usage of an AI tool in a specific AgentControl config variation.
    • Field Detail

      • SERIALIZED_NAME_AI_CONFIG_KEY

        public static final java.lang.String SERIALIZED_NAME_AI_CONFIG_KEY
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_AI_CONFIG_NAME

        public static final java.lang.String SERIALIZED_NAME_AI_CONFIG_NAME
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_VARIATION_ID

        public static final java.lang.String SERIALIZED_NAME_VARIATION_ID
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_VARIATION_KEY

        public static final java.lang.String SERIALIZED_NAME_VARIATION_KEY
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_VARIATION_NAME

        public static final java.lang.String SERIALIZED_NAME_VARIATION_NAME
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_TOOL_VERSION

        public static final java.lang.String SERIALIZED_NAME_TOOL_VERSION
        See Also:
        Constant Field Values
      • openapiFields

        public static java.util.HashSet<java.lang.String> openapiFields
      • openapiRequiredFields

        public static java.util.HashSet<java.lang.String> openapiRequiredFields
    • Constructor Detail

      • ToolReference

        public ToolReference()
    • Method Detail

      • aiConfigKey

        public ToolReference aiConfigKey​(@Nonnull
                                         java.lang.String aiConfigKey)
      • getAiConfigKey

        @Nonnull
        public java.lang.String getAiConfigKey()
        The key of the AgentControl config with a variation that references this tool.
        Returns:
        aiConfigKey
      • setAiConfigKey

        public void setAiConfigKey​(@Nonnull
                                   java.lang.String aiConfigKey)
      • aiConfigName

        public ToolReference aiConfigName​(@Nonnull
                                          java.lang.String aiConfigName)
      • getAiConfigName

        @Nonnull
        public java.lang.String getAiConfigName()
        The name of the AgentControl config with a variation that references this tool.
        Returns:
        aiConfigName
      • setAiConfigName

        public void setAiConfigName​(@Nonnull
                                    java.lang.String aiConfigName)
      • variationId

        public ToolReference variationId​(@Nonnull
                                         java.lang.String variationId)
      • getVariationId

        @Nonnull
        public java.lang.String getVariationId()
        The ID of the variation that references this tool.
        Returns:
        variationId
      • setVariationId

        public void setVariationId​(@Nonnull
                                   java.lang.String variationId)
      • variationKey

        public ToolReference variationKey​(@Nonnull
                                          java.lang.String variationKey)
      • getVariationKey

        @Nonnull
        public java.lang.String getVariationKey()
        The key of the AgentControl config variation that references this tool.
        Returns:
        variationKey
      • setVariationKey

        public void setVariationKey​(@Nonnull
                                    java.lang.String variationKey)
      • variationName

        public ToolReference variationName​(@Nonnull
                                           java.lang.String variationName)
      • getVariationName

        @Nonnull
        public java.lang.String getVariationName()
        The name of the variation that references this tool.
        Returns:
        variationName
      • setVariationName

        public void setVariationName​(@Nonnull
                                     java.lang.String variationName)
      • toolVersion

        public ToolReference toolVersion​(@Nonnull
                                         java.lang.Integer toolVersion)
      • getToolVersion

        @Nonnull
        public java.lang.Integer getToolVersion()
        The version of the tool being referenced.
        Returns:
        toolVersion
      • setToolVersion

        public void setToolVersion​(@Nonnull
                                   java.lang.Integer toolVersion)
      • putAdditionalProperty

        public ToolReference putAdditionalProperty​(java.lang.String key,
                                                   java.lang.Object value)
        Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
        Parameters:
        key - name of the property
        value - value of the property
        Returns:
        the ToolReference instance itself
      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
        Return the additional (undeclared) property.
        Returns:
        a map of objects
      • getAdditionalProperty

        public java.lang.Object getAdditionalProperty​(java.lang.String key)
        Return the additional (undeclared) property with the specified name.
        Parameters:
        key - name of the property
        Returns:
        an object
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • validateJsonElement

        public static void validateJsonElement​(com.google.gson.JsonElement jsonElement)
                                        throws java.io.IOException
        Validates the JSON Element and throws an exception if issues found
        Parameters:
        jsonElement - JSON Element
        Throws:
        java.io.IOException - if the JSON Element is invalid with respect to ToolReference
      • fromJson

        public static ToolReference fromJson​(java.lang.String jsonString)
                                      throws java.io.IOException
        Create an instance of ToolReference given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of ToolReference
        Throws:
        java.io.IOException - if the JSON string is invalid with respect to ToolReference
      • toJson

        public java.lang.String toJson()
        Convert an instance of ToolReference to an JSON string
        Returns:
        JSON string