Package com.google.genai.types

Class ApiKeyConfig

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.ApiKeyConfig

public abstract class ApiKeyConfig
extends JsonSerializable

Config for authentication with API key. This data type is not supported in Gemini API.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
ApiKeyConfig()

Method Summary

Modifier and Type	Method	Description
abstract Optional<String>	apiKeySecret()	Optional.
abstract Optional<String>	apiKeyString()	Optional.
static ApiKeyConfig.Builder	builder()	Instantiates a builder for ApiKeyConfig.
static ApiKeyConfig	fromJson(String jsonString)	Deserializes a JSON string to a ApiKeyConfig object.
abstract Optional<HttpElementLocation>	httpElementLocation()	Optional.
abstract Optional<String>	name()	Optional.
abstract ApiKeyConfig.Builder	toBuilder()	Creates a builder with the same values as this instance.

Methods inherited from class com.google.genai.JsonSerializable

setMaxReadLength, stringToJsonNode, toJson

Methods inherited from class java.lang.Object

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

Constructor Details

ApiKeyConfig

public ApiKeyConfig()

Method Details

apiKeySecret

public abstract Optional<String> apiKeySecret()

Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.

apiKeyString

public abstract Optional<String> apiKeyString()

Optional. The API key to be used in the request directly.

httpElementLocation

public abstract Optional<HttpElementLocation> httpElementLocation()

Optional. The location of the API key.

name

public abstract Optional<String> name()

Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.

builder

public static ApiKeyConfig.Builder builder()

Instantiates a builder for ApiKeyConfig.

toBuilder

public abstract ApiKeyConfig.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static ApiKeyConfig fromJson(String jsonString)

Deserializes a JSON string to a ApiKeyConfig object.