google-adk-kotlin-core/com.google.adk.kt.auth/AuthCredential/ApiKey

ApiKey

@ExperimentalAuthApi

data class ApiKey(val apiKey: Secret? = null) : AuthCredential

An API key, which the tool sends where the service's auth scheme says, such as in a header.

Constructors

constructor(apiKey: Secret? = null)

Types

Fluent builder for ApiKey, provided primarily for Java callers. Any property left unset falls back to the same default as the constructor.

object Companion

Properties

val apiKey: Secret?

The key, if the credential carries one.

Functions

fun toBuilder(): AuthCredential.ApiKey.Builder

Returns a Builder initialized with this instance's properties, primarily for Java callers. Prefer it over copy from Java: copy takes every property positionally, so its signature changes whenever a property is added.