Package com.google.genai.types

Class AuthConfig

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.AuthConfig

public abstract class AuthConfig
extends JsonSerializable

The authentication config to access the API.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
AuthConfig()

Method Summary

Modifier and Type	Method	Description
abstract Optional<String>	apiKey()	The authentication config to access the API.
abstract Optional<ApiKeyConfig>	apiKeyConfig()	Config for API key auth.
abstract Optional<AuthType>	authType()	Type of auth scheme.
static AuthConfig.Builder	builder()	Instantiates a builder for AuthConfig.
static AuthConfig	fromJson(String jsonString)	Deserializes a JSON string to a AuthConfig object.
abstract Optional<AuthConfigGoogleServiceAccountConfig>	googleServiceAccountConfig()	Config for Google Service Account auth.
abstract Optional<AuthConfigHttpBasicAuthConfig>	httpBasicAuthConfig()	Config for HTTP Basic auth.
abstract Optional<AuthConfigOauthConfig>	oauthConfig()	Config for user oauth.
abstract Optional<AuthConfigOidcConfig>	oidcConfig()	Config for user OIDC auth.
abstract AuthConfig.Builder	toBuilder()	Creates a builder with the same values as this instance.

Methods inherited from class com.google.genai.JsonSerializable

fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Details

AuthConfig

public AuthConfig()

Method Details

apiKey

public abstract Optional<String> apiKey()

The authentication config to access the API. Only API key is supported. This field is not supported in Gemini API.

apiKeyConfig

public abstract Optional<ApiKeyConfig> apiKeyConfig()

Config for API key auth.

authType

public abstract Optional<AuthType> authType()

Type of auth scheme.

googleServiceAccountConfig

public abstract Optional<AuthConfigGoogleServiceAccountConfig> googleServiceAccountConfig()

Config for Google Service Account auth.

httpBasicAuthConfig

public abstract Optional<AuthConfigHttpBasicAuthConfig> httpBasicAuthConfig()

Config for HTTP Basic auth.

oauthConfig

public abstract Optional<AuthConfigOauthConfig> oauthConfig()

Config for user oauth.

oidcConfig

public abstract Optional<AuthConfigOidcConfig> oidcConfig()

Config for user OIDC auth.

builder

public static AuthConfig.Builder builder()

Instantiates a builder for AuthConfig.

toBuilder

public abstract AuthConfig.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static AuthConfig fromJson(String jsonString)

Deserializes a JSON string to a AuthConfig object.