ToolValue class
JSON-typed scalar / composite carrier for tool arguments and results. Mirrors Swift's ToolValue enum, Kotlin's sealed class, and the TypeScript discriminated union. Used inside ToolParameter.enum_values (string-only) and as the canonical wire shape when consumers want strongly-typed arguments rather than raw JSON.
- Available extensions
Constructors
- ToolValue({String? stringValue, double? numberValue, bool? boolValue, ToolValueArray? arrayValue, ToolValueObject? objectValue, bool? nullValue})
-
factory
-
ToolValue.fromBuffer(List<
int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]) -
factory
- ToolValue.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
-
array
→ List<
ToolValue> ? -
Available on ToolValue, provided by the ToolValueAccessors extension
no setter - arrayValue ↔ ToolValueArray
-
getter/setter pair
- boolean → bool?
-
Available on ToolValue, provided by the ToolValueAccessors extension
no setter - boolValue ↔ bool
-
getter/setter pair
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- info_ → BuilderInfo
-
no setter
- intValue → int?
-
Available on ToolValue, provided by the ToolValueAccessors extension
no setter - isFrozen → bool
-
Returns
trueif this message is marked read-only. Otherwisefalse.no setterinherited - isNull → bool
-
Available on ToolValue, provided by the ToolValueAccessors extension
no setter - nullValue ↔ bool
-
getter/setter pair
- number → double?
-
Available on ToolValue, provided by the ToolValueAccessors extension
no setter - numberValue ↔ double
-
getter/setter pair
-
object
→ Map<
String, ToolValue> ? -
Available on ToolValue, provided by the ToolValueAccessors extension
no setter - objectValue ↔ ToolValueObject
-
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- string → String?
-
Available on ToolValue, provided by the ToolValueAccessors extension
no setter - stringValue ↔ String
-
getter/setter pair
- unknownFields → UnknownFieldSet
-
no setterinherited
Methods
-
addExtension(
Extension extension, Object? value) → void -
Adds an extension field value to a repeated field.
inherited
-
check(
) → void -
Throws a StateError if the message has required fields without a value.
inherited
-
clear(
) → void -
Clears all data that was set in this message.
inherited
-
clearArrayValue(
) → void -
clearBoolValue(
) → void -
clearExtension(
Extension extension) → void -
Clears an extension field and also removes the extension.
inherited
-
clearField(
int tagNumber) → void -
Clears the contents of a given field.
inherited
-
clearKind(
) → void -
clearNullValue(
) → void -
clearNumberValue(
) → void -
clearObjectValue(
) → void -
clearStringValue(
) → void -
clone(
) → ToolValue - Creates a deep copy of the fields in this message.
-
copyWith(
void updates(ToolValue)) → ToolValue -
Apply
updatesto a copy of this message. -
createEmptyInstance(
) → ToolValue - Creates an empty instance of the same message type as this.
-
deepCopy(
) → T -
Available on T, provided by the GeneratedMessageGenericExtensions extension
Returns a writable deep copy of this message. -
ensureArrayValue(
) → ToolValueArray -
ensureObjectValue(
) → ToolValueObject -
extensionsAreInitialized(
) → bool -
inherited
-
freeze(
) → GeneratedMessage -
Make this message read-only.
inherited
-
getDefaultForField(
int tagNumber) → dynamic -
Returns the default value for the given field.
inherited
-
getExtension(
Extension extension) → dynamic -
Returns the value of
extension.inherited -
getField(
int tagNumber) → dynamic -
Returns the value of the field associated with
tagNumber, or the default value if it is not set.inherited -
getFieldOrNull(
int tagNumber) → dynamic -
Returns the value of a field, ignoring any defaults.
inherited
-
getTagNumber(
String fieldName) → int? -
inherited
-
hasArrayValue(
) → bool -
hasBoolValue(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
trueif a value ofextensionis present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber.inherited -
hasNullValue(
) → bool -
hasNumberValue(
) → bool -
hasObjectValue(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasStringValue(
) → bool -
isInitialized(
) → bool -
Whether all required fields in the message and embedded messages are set.
inherited
-
mergeFromBuffer(
List< int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges serialized protocol buffer data into this message.
inherited
-
mergeFromCodedBufferReader(
CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Same as
mergeFromBuffer, but takes aCodedBufferReaderinput.inherited -
mergeFromJson(
String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from
data, a JSON object, encoded as described byGeneratedMessage.writeToJson.inherited -
mergeFromJsonMap(
Map< String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from a JSON object represented as a Dart map.
inherited
-
mergeFromMessage(
GeneratedMessage other) → void -
Merges the contents of the
otherinto this message.inherited -
mergeFromProto3Json(
Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void -
Merges field values from
json, a JSON object using proto3 encoding.inherited -
mergeUnknownFields(
UnknownFieldSet unknownFieldSet) → void -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
rebuild(
void updates(T)) → T -
Available on T, provided by the GeneratedMessageGenericExtensions extension
Applyupdatesto a copy of this message. -
setExtension(
Extension extension, Object value) → void -
Sets the value of a non-repeated extension field to
value.inherited -
setField(
int tagNumber, Object value) → void -
Sets the value of a field by its
tagNumber.inherited -
toBuilder(
) → GeneratedMessage -
Creates a writable, shallow copy of this message.
inherited
-
toDebugString(
) → String -
Returns a String representation of this message.
inherited
-
toJSONString(
) → String? -
Available on ToolValue, provided by the ToolValueAccessors extension
-
toProto3Json(
{TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object? -
Returns an Object representing Proto3 JSON serialization of
this.inherited -
toString(
) → String -
Returns a String representation of this message.
inherited
-
whichKind(
) → ToolValue_Kind -
writeToBuffer(
) → Uint8List -
Serialize the message as the protobuf binary format.
inherited
-
writeToCodedBufferWriter(
CodedBufferWriter output) → void -
Same as
writeToBuffer, but serializes to the givenCodedBufferWriter.inherited -
writeToJson(
) → String -
Returns a JSON string that encodes this message.
inherited
-
writeToJsonMap(
) → Map< String, dynamic> -
Returns the JSON encoding of this message as a Dart Map.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
create(
) → ToolValue -
getDefault(
) → ToolValue