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

ApiKey

@ExperimentalAuthApi

data class ApiKey(val name: String, val location: AuthScheme.ApiKey.Location, val description: String? = null) : AuthScheme

An API key scheme: where the key is sent, and under which name.

Constructors

constructor(name: String, location: AuthScheme.ApiKey.Location, description: String? = 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

@ExperimentalAuthApi

enum Location : Enum<AuthScheme.ApiKey.Location>

Where an API key is sent.

Properties

val description: String?

A description of the scheme.

val location: AuthScheme.ApiKey.Location

Where the key is sent: OpenAPI's in.

val name: String

The name of the header, query parameter or cookie that carries the key.

open override val type: String

The scheme's OpenAPI type, such as apiKey or http.

Functions

fun toBuilder(): AuthScheme.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.