Package com.commercetools.api.models.mcp_server

Class ParameterOverrideBuilder

java.lang.Object
com.commercetools.api.models.mcp_server.ParameterOverrideBuilder
All Implemented Interfaces:
Builder<ParameterOverride>
public class ParameterOverrideBuilder extends Object implements Builder<ParameterOverride>
ParameterOverrideBuilder
Example to create an instance using the builder pattern 

     ParameterOverride parameterOverride = ParameterOverride.builder()
             .name("{name}")
             .build()

  • Constructor Details

    • ParameterOverrideBuilder

      public ParameterOverrideBuilder()

  • Method Details

    • name

      public ParameterOverrideBuilder name(String name)

      Name of the parameter in the tool's input schema to override.

      Parameters:
      name - value to be set
      Returns:
      Builder

    • description

      public ParameterOverrideBuilder description(@Nullable String description)

      Replacement description for the parameter, shown to the AI agent.

      Parameters:
      description - value to be set
      Returns:
      Builder

    • _const

      public ParameterOverrideBuilder _const(@Nullable Object _const)

      Pins the parameter to a fixed value. Mutually exclusive with default and allowedTypes.

      Parameters:
      _const - value to be set
      Returns:
      Builder

    • _default

      public ParameterOverrideBuilder _default(@Nullable Object _default)

      Default value applied when the caller omits the parameter. Mutually exclusive with const.

      Parameters:
      _default - value to be set
      Returns:
      Builder

    • allowedTypes

      public ParameterOverrideBuilder allowedTypes(@Nullable Object... allowedTypes)

      Restricts accepted values to this set. Mutually exclusive with const.

      Parameters:
      allowedTypes - value to be set
      Returns:
      Builder

    • allowedTypes

      public ParameterOverrideBuilder allowedTypes(@Nullable List<Object> allowedTypes)

      Restricts accepted values to this set. Mutually exclusive with const.

      Parameters:
      allowedTypes - value to be set
      Returns:
      Builder

    • plusAllowedTypes

      public ParameterOverrideBuilder plusAllowedTypes(@Nullable Object... allowedTypes)

      Restricts accepted values to this set. Mutually exclusive with const.

      Parameters:
      allowedTypes - value to be set
      Returns:
      Builder

    • getName

      public String getName()

      Name of the parameter in the tool's input schema to override.

      Returns:
      name

    • getDescription

      @Nullable public String getDescription()

      Replacement description for the parameter, shown to the AI agent.

      Returns:
      description

    • getConst

      @Nullable public Object getConst()

      Pins the parameter to a fixed value. Mutually exclusive with default and allowedTypes.

      Returns:
      const

    • getDefault

      @Nullable public Object getDefault()

      Default value applied when the caller omits the parameter. Mutually exclusive with const.

      Returns:
      default

    • getAllowedTypes

      @Nullable public List<Object> getAllowedTypes()

      Restricts accepted values to this set. Mutually exclusive with const.

      Returns:
      allowedTypes

    • build

      public ParameterOverride build()
      builds ParameterOverride with checking for non-null required values
      Specified by:
      build in interface Builder<ParameterOverride>
      Returns:
      ParameterOverride

    • buildUnchecked

      public ParameterOverride buildUnchecked()
      builds ParameterOverride without checking for non-null required values
      Returns:
      ParameterOverride

    • of

      public static ParameterOverrideBuilder of()
      factory method for an instance of ParameterOverrideBuilder
      Returns:
      builder

    • of

      public static ParameterOverrideBuilder of(ParameterOverride template)
      create builder for ParameterOverride instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder