google-genai/com.google.genai.types/HttpOptions

HttpOptions

public abstract class HttpOptions extends JsonSerializable

HTTP options to be used in each of the requests.

Constructors

Link copied to clipboard
public void HttpOptions()

Types

Link copied to clipboard
public abstract class Builder
Builder for HttpOptions.

Properties

Link copied to clipboard
public final static String MAX_READ_LENGTH_PROPERTY
System property to override the default max JSON string length (20MB) in read constraints.

Functions

Link copied to clipboard
public abstract Optional<String> apiVersion()
Specifies the version of the API to use.
Link copied to clipboard
public abstract Optional<String> baseUrl()
The base URL for the AI platform service endpoint.
Link copied to clipboard
public abstract Optional<ResourceScope> baseUrlResourceScope()
The resource scope used to constructing the resource name when base_url is set
Link copied to clipboard
public static HttpOptions.Builder builder()
Instantiates a builder for HttpOptions.
Link copied to clipboard
public abstract Optional<Map<String, Object>> extraBody()
Extra parameters to add to the request body.
Link copied to clipboard
public static HttpOptions fromJson(String jsonString)
Deserializes a JSON string to a HttpOptions object.
Link copied to clipboard
@InternalApi()
public static T fromJsonNode<T extends JsonSerializable>(JsonNode jsonNode, Class<T> clazz)
Deserializes a JsonNode to an object of the given type.
Link copied to clipboard
@InternalApi()
public static T fromJsonString<T extends JsonSerializable>(String jsonString, Class<T> clazz)
Deserializes a Json string to an object of the given type.
Link copied to clipboard
public abstract Optional<Map<String, String>> headers()
Additional HTTP headers to be sent with the request.
Link copied to clipboard
public static ObjectMapper objectMapper()
Link copied to clipboard
public abstract Optional<HttpRetryOptions> retryOptions()
HTTP retry options for the request.
Link copied to clipboard
public static void setMaxReadLength(int maxReadLength)
Overrides the default maximum JSON string length (20MB) for the JSON parser.
Link copied to clipboard
public static JsonNode stringToJsonNode(String string)
Converts a Json string to a JsonNode.
Link copied to clipboard
public abstract Optional<Integer> timeout()
Timeout for the request in milliseconds.
Link copied to clipboard
public abstract HttpOptions.Builder toBuilder()
Creates a builder with the same values as this instance.
Link copied to clipboard
public String toJson()
Serializes the instance to a Json string.
Link copied to clipboard
public static JsonNode toJsonNode(Object object)
Serializes an object to a JsonNode.
Link copied to clipboard
public static String toJsonString(Object object)
Serializes an object to a Json string.