# RequestFinishedInfo


```
abstract class RequestFinishedInfo
```

<br />

*** ** * ** ***

Information about a finished request. Passed to `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo.Listener`.

To associate the data with the original request, use `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlRequest.Builder#addRequestAnnotation(java.lang.Object)` to add a unique identifier when creating the request, and call `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo#getAnnotations()` when the `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo` is received to retrieve the identifier.

## Summary

| ### Nested types |
|---|
| `abstract class https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo.Listener` Listens for finished requests for the purpose of collecting metrics. |
| `abstract class https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo.Metrics` Metrics collected for a single request. |

| ### Constants |
|---|---|
| `const https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo#CANCELED() = 2` Reason value indicating that the request was canceled. |
| `const https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo#FAILED() = 1` Reason value indicating that the request failed or returned an error. |
| `const https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo#SUCCEEDED() = 0` Reason value indicating that the request succeeded. |

| ### Public constructors |
|---|
| `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo#RequestFinishedInfo()()` |

| ### Public functions |
|---|---|
| `abstract (https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-collection/index.html)https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-collection/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html!>!` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo#getAnnotations()()` Returns the objects that the caller has supplied when initiating the request, using `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlRequest.Builder#addRequestAnnotation(java.lang.Object)`. |
| `abstract https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetException?` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo#getException()()` If the request failed, returns the same `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetException` provided to `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlRequest.Callback#onFailed(org.chromium.net.UrlRequest,org.chromium.net.UrlResponseInfo,org.chromium.net.CronetException)`. |
| `abstract https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo#getFinishedReason()()` Returns the reason why the request finished. |
| `abstract https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo.Metrics!` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo#getMetrics()()` Returns metrics collected for this request. |
| `abstract https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo?` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo#getResponseInfo()()` Returns a `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo` for the request, if its response had started. |
| `abstract https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html!` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo#getUrl()()` Returns the request's original URL. |

## Constants

### CANCELED

```
const val CANCELED = 2: Int
```

Reason value indicating that the request was canceled. Returned from `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo#getFinishedReason()`.

### FAILED

```
const val FAILED = 1: Int
```

Reason value indicating that the request failed or returned an error. Returned from `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo#getFinishedReason()`.

### SUCCEEDED

```
const val SUCCEEDED = 0: Int
```

Reason value indicating that the request succeeded. Returned from `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo#getFinishedReason()`.

## Public constructors

### RequestFinishedInfo

```
RequestFinishedInfo()
```

## Public functions

### getAnnotations

```
abstract fun getAnnotations(): (Mutable)Collection<Any!>!
```

Returns the objects that the caller has supplied when initiating the request, using `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlRequest.Builder#addRequestAnnotation(java.lang.Object)`. Annotations can be used to associate a `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo` with the original request or type of request.

| Returns |
|---|---|
| `(https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-collection/index.html)https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-collection/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html!>!` | annotations supplied when creating the request |

### getException

```
abstract fun getException(): CronetException?
```

If the request failed, returns the same `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetException` provided to `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlRequest.Callback#onFailed(org.chromium.net.UrlRequest,org.chromium.net.UrlResponseInfo,org.chromium.net.CronetException)`.

| Returns |
|---|---|
| `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetException?` | the request's `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/CronetException`, if the request failed |

### getFinishedReason

```
abstract fun getFinishedReason(): Int
```

Returns the reason why the request finished.

| Returns |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | one of `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo#SUCCEEDED()`, `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo#FAILED()`, or `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo#CANCELED()` |

### getMetrics

```
abstract fun getMetrics(): RequestFinishedInfo.Metrics!
```

Returns metrics collected for this request.

The reported times and bytes account for all redirects, i.e. the TTFB is from the start of the original request to the ultimate response headers, the TTLB is from the start of the original request to the end of the ultimate response, the received byte count is for all redirects and the ultimate response combined. These cumulative metric definitions are debatable, but are chosen to make sense for user-facing latency analysis.

| Returns |
|---|---|
| `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/RequestFinishedInfo.Metrics!` | metrics collected for this request. |

### getResponseInfo

```
abstract fun getResponseInfo(): UrlResponseInfo?
```

Returns a `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo` for the request, if its response had started.

| Returns |
|---|---|
| `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo?` | `https://developer.android.com/develop/connectivity/cronet/reference/kotlin/org/chromium/net/UrlResponseInfo` for the request, if its response had started. |

### getUrl

```
abstract fun getUrl(): String!
```

Returns the request's original URL.

| Returns |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html!` | the request's original URL |