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

Http

data class Http(val scheme: String, val credentials: AuthCredential.Http.Credentials, val additionalHeaders: Map<String, Secret>? = null) : AuthCredential

An HTTP authentication credential, usually sent in the Authorization header.

Constructors

Http

constructor(scheme: String, credentials: AuthCredential.Http.Credentials, additionalHeaders: Map<String, Secret>? = null)

Types

Builder

class Builder

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

Companion

object Companion

Credentials

@ExperimentalAuthApi

data class Credentials(val username: String? = null, val password: Secret? = null, val token: Secret? = null)

What an HTTP credential authenticates with: a user name and password, or a token.

Properties

additionalHeaders

val additionalHeaders: Map<String, Secret>?

Extra headers to send with the request. Their values are secret.

credentials

val credentials: AuthCredential.Http.Credentials

The user name and password, or the token.

scheme

val scheme: String

The Authorization header scheme (RFC 7235), such as basic or bearer.

Functions

toBuilder

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