Package com.google.genai.types
Class PartialArg
-
- All Implemented Interfaces:
public abstract class PartialArg extends JsonSerializable
Partial argument value of the function call. This data type is not supported in Gemini API.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public abstract classPartialArg.BuilderBuilder for PartialArg.
-
Field Summary
Fields Modifier and Type Field Description public final static StringMAX_READ_LENGTH_PROPERTY
-
Constructor Summary
Constructors Constructor Description PartialArg()
-
Method Summary
Modifier and Type Method Description abstract Optional<Boolean>boolValue()Optional. abstract Optional<String>jsonPath()Required. abstract Optional<NullValue>nullValue()Optional. abstract Optional<Double>numberValue()Optional. abstract Optional<String>stringValue()Optional. abstract Optional<Boolean>willContinue()Optional. static PartialArg.Builderbuilder()Instantiates a builder for PartialArg. abstract PartialArg.BuildertoBuilder()Creates a builder with the same values as this instance. static PartialArgfromJson(String jsonString)Deserializes a JSON string to a PartialArg object. -
Methods inherited from class com.google.genai.JsonSerializable
fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
jsonPath
abstract Optional<String> jsonPath()
Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
-
numberValue
abstract Optional<Double> numberValue()
Optional. Represents a double value.
-
stringValue
abstract Optional<String> stringValue()
Optional. Represents a string value.
-
willContinue
abstract Optional<Boolean> willContinue()
Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.
-
builder
static PartialArg.Builder builder()
Instantiates a builder for PartialArg.
-
toBuilder
abstract PartialArg.Builder toBuilder()
Creates a builder with the same values as this instance.
-
fromJson
static PartialArg fromJson(String jsonString)
Deserializes a JSON string to a PartialArg object.
-
-
-
-