Package net.thevpc.naru.api.registry

Class NaruToolParameter

java.lang.Object

net.thevpc.naru.api.registry.NaruToolParameter

public class NaruToolParameter
extends Object

Builder for a single parameter inside a JSON schema "properties" block.

   ToolParameter.string("path", "Absolute or relative file path", true)
   ToolParameter.integer("timeout_seconds", "Max wait time", false)
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NaruToolParameter.Builder
static enum	NaruToolParameter.Type

Method Summary

Modifier and Type	Method	Description
static NaruToolParameter.Builder	array(String name, String description, boolean required, NaruToolParameter itemType)
static NaruToolParameter.Builder	bool(String name, String description, boolean required)
static NaruToolParameter.Builder	bool(String name, String description, boolean required, boolean defaultValue)
Boolean	getAdditionalProperties()
Object	getDefaultValue()
String	getDescription()
List<Object>	getEnumValues()
Number	getExclusiveMaximum()
Number	getExclusiveMinimum()
String	getFormat()
NaruToolParameter	getItemType()
Number	getMaximum()
Integer	getMaxItems()
Integer	getMaxLength()
Number	getMinimum()
Integer	getMinItems()
Integer	getMinLength()
Number	getMultipleOf()
String	getName()
String	getPattern()
List<NaruToolParameter>	getProperties()
NaruToolParameter.Type	getType()
Boolean	getUniqueItems()
static NaruToolParameter.Builder	integer(String name, String description, boolean required)
static NaruToolParameter.Builder	integer(String name, String description, boolean required, int defaultValue)
boolean	isNullable()
boolean	isRequired()
static NaruToolParameter.Builder	number(String name, String description, boolean required)
static NaruToolParameter.Builder	number(String name, String description, boolean required, Number defaultValue)
static NaruToolParameter.Builder	object(String name, String description, boolean required, NaruToolParameter... properties)
static NaruToolParameter.Builder	string(String name, String description, boolean required)
static NaruToolParameter.Builder	string(String name, String description, boolean required, String defaultValue)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getName

public String getName()

getType

public NaruToolParameter.Type getType()

getDescription

public String getDescription()

getDefaultValue

public Object getDefaultValue()

isRequired

public boolean isRequired()

getEnumValues

public List<Object> getEnumValues()

isNullable

public boolean isNullable()

getFormat

public String getFormat()

getMinLength

public Integer getMinLength()

getMaxLength

public Integer getMaxLength()

getPattern

public String getPattern()

getMinimum

public Number getMinimum()

getMaximum

public Number getMaximum()

getExclusiveMinimum

public Number getExclusiveMinimum()

getExclusiveMaximum

public Number getExclusiveMaximum()

getMultipleOf

public Number getMultipleOf()

getItemType

public NaruToolParameter getItemType()

getMinItems

public Integer getMinItems()

getMaxItems

public Integer getMaxItems()

getUniqueItems

public Boolean getUniqueItems()

getProperties

public List<NaruToolParameter> getProperties()

getAdditionalProperties

public Boolean getAdditionalProperties()

string

public static NaruToolParameter.Builder string(String name,
 String description,
 boolean required)

string

public static NaruToolParameter.Builder string(String name,
 String description,
 boolean required,
 String defaultValue)

integer

public static NaruToolParameter.Builder integer(String name,
 String description,
 boolean required)

integer

public static NaruToolParameter.Builder integer(String name,
 String description,
 boolean required,
 int defaultValue)

number

public static NaruToolParameter.Builder number(String name,
 String description,
 boolean required)

number

public static NaruToolParameter.Builder number(String name,
 String description,
 boolean required,
 Number defaultValue)

bool

public static NaruToolParameter.Builder bool(String name,
 String description,
 boolean required)

bool

public static NaruToolParameter.Builder bool(String name,
 String description,
 boolean required,
 boolean defaultValue)

array

public static NaruToolParameter.Builder array(String name,
 String description,
 boolean required,
 NaruToolParameter itemType)

object

public static NaruToolParameter.Builder object(String name,
 String description,
 boolean required,
 NaruToolParameter... properties)