google-genai-kotlin/com.google.genai.kotlin.types/ApiKeyConfig

ApiKeyConfig

@Serializable
data class ApiKeyConfig(val apiKeySecret: String? = null, val apiKeyString: String? = null, val httpElementLocation: HttpElementLocation? = null, val name: String? = null)

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

Constructors

Link copied to clipboard
constructor(apiKeySecret: String? = null, apiKeyString: String? = null, httpElementLocation: HttpElementLocation? = null, name: String? = null)

Properties

Link copied to clipboard
val apiKeySecret: String? = null

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.

Link copied to clipboard
val apiKeyString: String? = null

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

Link copied to clipboard
val httpElementLocation: HttpElementLocation? = null

Optional. The location of the API key.

Link copied to clipboard
val name: String? = null

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.