koogle-api-common/io.github.edricchan03.koogle_api.common.http.headers

Package-level declarations

Types

KoogleHeadersBuilder

abstract class KoogleHeadersBuilder(headersBuilder: HeadersBuilder) : StringValuesBuilder

Top-level class that all header builders should extend from.

SystemHeadersBuilder

class SystemHeadersBuilder(headersBuilder: HeadersBuilder) : KoogleHeadersBuilder

HTTP headers that can be passed to any Google API.

Properties

apiClientHeader

const val apiClientHeader: String

Corresponds to the X-Goog-Api-Client HTTP header.

apiKeyHeader

const val apiKeyHeader: String

Corresponds to the X-Goog-Api-Key HTTP header.

authHeader

const val authHeader: String

Corresponds to the Authorization HTTP header.

contentTypeHeader

const val contentTypeHeader: String

Corresponds to the Content-Type HTTP header.

fieldsHeader

const val fieldsHeader: String

Corresponds to the X-Goog-FieldMask HTTP header.

httpMethodOverrideHeader

const val httpMethodOverrideHeader: String

Corresponds to the X-HTTP-Method-Override HTTP header.

quotaUserHeader

const val quotaUserHeader: String

Corresponds to the X-Goog-Quota-User HTTP header.

requestParamsHeader

const val requestParamsHeader: String

Corresponds to the x-goog-request-params HTTP header.

requestReasonHeader

const val requestReasonHeader: String

Corresponds to the X-Goog-Request-Reason HTTP header.

serverTimeoutHeader

const val serverTimeoutHeader: String

Corresponds to the X-Server-Timeout HTTP header.

userProjectHeader

const val userProjectHeader: String

Corresponds to the X-Goog-User-Project HTTP header.

Inherited functions

contentTypeValue

fun StringValuesBuilder.contentTypeValue(name: String? = null): ValueSingleDelegateProvider<ContentType?>

Creates an optional Content-Type header of type ContentType with the given name in this KoogleHeadersBuilder instance.

contentTypeValues

fun StringValuesBuilder.contentTypeValues(name: String? = null): NamedValuePropertyProvider<List<ContentType>?>

Creates an optional Content-Type header of type List<ContentType> with the given name in this KoogleHeadersBuilder instance.

systemHeaders

fun HttpRequestBuilder.systemHeaders(headersInit: SystemHeadersBuilder.() -> Unit)

Sets the SystemHeadersBuilder on the HttpRequestBuilder receiver.