smithy-client/aws.smithy.kotlin.runtime.client/LogMode

LogMode

sealed class LogMode

LogMode represents the logging mode of SDK clients. The mode is backed by a bit-field where each bit is a flag (mode) that describes the logging behavior for one or more client components.

Example: Setting log mode to enable logging of requests and responses

val mode = LogMode.LogRequest + LogMode.LogResponse

Inheritors

Types

Companion

object Companion

Default

object Default : LogMode

The default logging mode which does not opt-in to anything

LogRequest

object LogRequest : LogMode

Log the request details, e.g. url, headers, etc.

LogRequestWithBody

object LogRequestWithBody : LogMode

Log the request details as well as the body if possible

LogResponse

object LogResponse : LogMode

Log the response details, e.g. status, headers, etc

LogResponseWithBody

object LogResponseWithBody : LogMode

Log the response details as well as the body if possible

Functions

equals

open operator override fun equals(other: Any?): Boolean

isEnabled

fun isEnabled(mode: LogMode): Boolean

Test if a particular LogMode is enabled

minus

operator fun minus(mode: LogMode): LogMode

plus

operator fun plus(mode: LogMode): LogMode

toString

open override fun toString(): String