Package com.google.genai.types

Class HttpOptions

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.HttpOptions

public abstract class HttpOptions
extends JsonSerializable

HTTP options to be used in each of the requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpOptions.Builder	Builder for HttpOptions.

Constructor Summary

Constructors

Constructor	Description
HttpOptions()

Method Summary

Modifier and Type	Method	Description
abstract Optional<String>	apiVersion()	Specifies the version of the API to use.
abstract Optional<String>	baseUrl()	The base URL for the AI platform service endpoint.
static HttpOptions.Builder	builder()	Instantiates a builder for HttpOptions.
abstract Optional<Map<String,Object>>	extraBody()	Extra parameters to add to the request body.
static HttpOptions	fromJson(String jsonString)	Deserializes a JSON string to a HttpOptions object.
abstract Optional<Map<String,String>>	headers()	Additional HTTP headers to be sent with the request.
abstract Optional<Integer>	timeout()	Timeout for the request in milliseconds.
abstract HttpOptions.Builder	toBuilder()	Creates a builder with the same values as this instance.

Methods inherited from class com.google.genai.JsonSerializable

stringToJsonNode, toJson

Methods inherited from class java.lang.Object

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

Constructor Details

HttpOptions

public HttpOptions()

Method Details

baseUrl

public abstract Optional<String> baseUrl()

The base URL for the AI platform service endpoint.

apiVersion

public abstract Optional<String> apiVersion()

Specifies the version of the API to use.

headers

public abstract Optional<Map<String,String>> headers()

Additional HTTP headers to be sent with the request.

timeout

public abstract Optional<Integer> timeout()

Timeout for the request in milliseconds.

extraBody

public abstract Optional<Map<String,Object>> extraBody()

Extra parameters to add to the request body. The structure must match the backend API's request structure. - VertexAI backend API docs: https://cloud.google.com/vertex-ai/docs/reference/rest - GeminiAPI backend API docs: https://ai.google.dev/api/rest

builder

public static HttpOptions.Builder builder()

Instantiates a builder for HttpOptions.

toBuilder

public abstract HttpOptions.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static HttpOptions fromJson(String jsonString)

Deserializes a JSON string to a HttpOptions object.