firebase-perf/com.google.firebase.perf.metrics/HttpMetric

HttpMetric

Header stub; see FirebasePerformance.android.kt.

An in-memory HTTP metric (see FirebasePerformance.jvm.kt).

A metric of one HTTP request, as the Android SDK's com.google.firebase.perf.metrics.HttpMetric. The JS SDK has no custom HTTP metrics (it records network requests itself), so this class exists on Android, the JVM and Apple platforms.

Types

Companion

actual object Companion

expect object Companion

Properties

attributes

actual val attributes: Map<String, String>

All custom attributes of this metric.

actual val attributes: Map<String, String>

All custom attributes of this metric.

actual val attributes: Map<String, String>

All custom attributes of this metric.

expect val attributes: Map<String, String>

All custom attributes of this metric.

httpMethod

val httpMethod: String

The HTTP method, one of com.google.firebase.perf.FirebasePerformance.HttpMethod.

httpResponseCode

var httpResponseCode: Int?

The value last given to setHttpResponseCode, or null.

ios

val ios: FIRHTTPMetric

The underlying Firebase iOS SDK object.

requestPayloadSize

var requestPayloadSize: Long?

The value last given to setRequestPayloadSize, or null.

responseContentType

var responseContentType: String?

The value last given to setResponseContentType, or null.

responsePayloadSize

var responsePayloadSize: Long?

The value last given to setResponsePayloadSize, or null.

url

val url: String

The request URL.

Functions

equals

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

getAttribute

actual fun getAttribute(attribute: String): String?

The value of the custom attribute attribute, or null if it is not set.

actual fun getAttribute(attribute: String): String?

The value of the custom attribute attribute, or null if it is not set.

actual fun getAttribute(attribute: String): String?

The value of the custom attribute attribute, or null if it is not set.

expect fun getAttribute(attribute: String): String?

The value of the custom attribute attribute, or null if it is not set.

hashCode

open override fun hashCode(): Int

putAttribute

actual fun putAttribute(attribute: String, value: String)

Sets the custom attribute attribute to value.

actual fun putAttribute(attribute: String, value: String)

Sets the custom attribute attribute to value.

actual fun putAttribute(attribute: String, value: String)

Sets the custom attribute attribute to value.

expect fun putAttribute(attribute: String, value: String)

Sets the custom attribute attribute to value.

removeAttribute

actual fun removeAttribute(attribute: String)

Removes the custom attribute attribute.

actual fun removeAttribute(attribute: String)

Removes the custom attribute attribute.

actual fun removeAttribute(attribute: String)

Removes the custom attribute attribute.

expect fun removeAttribute(attribute: String)

Removes the custom attribute attribute.

setHttpResponseCode

actual fun setHttpResponseCode(responseCode: Int)

Sets the HTTP response status code.

actual fun setHttpResponseCode(responseCode: Int)

Sets the HTTP response status code.

actual fun setHttpResponseCode(responseCode: Int)

Sets the HTTP response status code.

expect fun setHttpResponseCode(responseCode: Int)

Sets the HTTP response status code.

setRequestPayloadSize

actual fun setRequestPayloadSize(bytes: Long)

Sets the size of the request payload in bytes.

actual fun setRequestPayloadSize(bytes: Long)

Sets the size of the request payload in bytes.

actual fun setRequestPayloadSize(bytes: Long)

Sets the size of the request payload in bytes.

expect fun setRequestPayloadSize(bytes: Long)

Sets the size of the request payload in bytes.

setResponseContentType

actual fun setResponseContentType(contentType: String?)

Sets the content type of the response.

actual fun setResponseContentType(contentType: String?)

Sets the content type of the response.

actual fun setResponseContentType(contentType: String?)

Sets the content type of the response.

expect fun setResponseContentType(contentType: String?)

Sets the content type of the response.

setResponsePayloadSize

actual fun setResponsePayloadSize(bytes: Long)

Sets the size of the response payload in bytes.

actual fun setResponsePayloadSize(bytes: Long)

Sets the size of the response payload in bytes.

actual fun setResponsePayloadSize(bytes: Long)

Sets the size of the response payload in bytes.

expect fun setResponsePayloadSize(bytes: Long)

Sets the size of the response payload in bytes.

start

actual fun start()

Marks the start of the request.

actual fun start()

Marks the start of the request.

actual fun start()

Marks the start of the request.

expect fun start()

Marks the start of the request.

stop

actual fun stop()

Marks the end of the response and reports the metric.

actual fun stop()

Marks the end of the response and reports the metric.

actual fun stop()

Marks the end of the response and reports the metric.

expect fun stop()

Marks the end of the response and reports the metric.

toString

open override fun toString(): String

trace

inline fun HttpMetric.trace(block: HttpMetric.() -> Unit)

Runs block between HttpMetric.start and HttpMetric.stop of this metric.