Added in API level 35

ProfilingResult

---

Kotlin |Java

class ProfilingResult : Parcelable

kotlin.Any
↳	android.os.ProfilingResult

Encapsulates results of a single profiling request operation.

Summary

Constants
static Int	ERROR_FAILED_EXECUTING The request was executed and failed for a reason not specified below.
static Int	ERROR_FAILED_INVALID_REQUEST The request failed due to invalid ProfilingRequest.
static Int	ERROR_FAILED_NO_DISK_SPACE The request was executed and failed due to a lack of disk space.
static Int	ERROR_FAILED_POST_PROCESSING The request was executed but post processing failed and the result was discarded.
static Int	ERROR_FAILED_PROFILING_IN_PROGRESS The request was denied due to profiling already in progress.
static Int	ERROR_FAILED_RATE_LIMIT_PROCESS The request was denied due to process level rate limiting.
static Int	ERROR_FAILED_RATE_LIMIT_SYSTEM The request was denied due to system level rate limiting.
static Int	ERROR_NONE The request was executed and succeeded.
static Int	ERROR_UNKNOWN The request was denied or failed for an unspecified reason.

Inherited constants

From class Parcelable Int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. Int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	describeContents()
Int	getErrorCode() The result ErrorCode for the profiling request indicating the failure reason if applicable.
String?	getErrorMessage() Additional details about failures that occurred, if applicable.
String?	getResultFilePath() The file path of the profiling result data.
String?	getTag() The tag defined by the caller at request time.
Int	getTriggerType() Trigger type that started this profiling, or ProfilingTrigger.TRIGGER_TYPE_NONE for profiling not started by a trigger.
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<ProfilingResult!>	CREATOR

Constants

ERROR_FAILED_EXECUTING

Added in API level 35

static val ERROR_FAILED_EXECUTING: Int

The request was executed and failed for a reason not specified below.

Value: 4

ERROR_FAILED_INVALID_REQUEST

Added in API level 35

static val ERROR_FAILED_INVALID_REQUEST: Int

The request failed due to invalid ProfilingRequest.

Value: 7

ERROR_FAILED_NO_DISK_SPACE

Added in API level 35

static val ERROR_FAILED_NO_DISK_SPACE: Int

The request was executed and failed due to a lack of disk space.

Value: 6

ERROR_FAILED_POST_PROCESSING

Added in API level 35

static val ERROR_FAILED_POST_PROCESSING: Int

The request was executed but post processing failed and the result was discarded.

Value: 5

ERROR_FAILED_PROFILING_IN_PROGRESS

Added in API level 35

static val ERROR_FAILED_PROFILING_IN_PROGRESS: Int

The request was denied due to profiling already in progress.

Value: 3

ERROR_FAILED_RATE_LIMIT_PROCESS

Added in API level 35

static val ERROR_FAILED_RATE_LIMIT_PROCESS: Int

The request was denied due to process level rate limiting.

Value: 2

ERROR_FAILED_RATE_LIMIT_SYSTEM

Added in API level 35

static val ERROR_FAILED_RATE_LIMIT_SYSTEM: Int

The request was denied due to system level rate limiting.

Value: 1

ERROR_NONE

Added in API level 35

static val ERROR_NONE: Int

The request was executed and succeeded.

Value: 0

ERROR_UNKNOWN

Added in API level 35

static val ERROR_UNKNOWN: Int

The request was denied or failed for an unspecified reason.

Value: 8

Public methods

describeContents

Added in API level 35

fun describeContents(): Int

Return
Int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

getErrorCode

Added in API level 35

fun getErrorCode(): Int

The result ErrorCode for the profiling request indicating the failure reason if applicable.

Return

Int

Value is android.os.ProfilingResult#ERROR_NONE, android.os.ProfilingResult#ERROR_FAILED_RATE_LIMIT_SYSTEM, android.os.ProfilingResult#ERROR_FAILED_RATE_LIMIT_PROCESS, android.os.ProfilingResult#ERROR_FAILED_PROFILING_IN_PROGRESS, android.os.ProfilingResult#ERROR_FAILED_EXECUTING, android.os.ProfilingResult#ERROR_FAILED_POST_PROCESSING, android.os.ProfilingResult#ERROR_FAILED_NO_DISK_SPACE, or android.os.ProfilingResult#ERROR_UNKNOWN

getErrorMessage

Added in API level 35

fun getErrorMessage(): String?

Additional details about failures that occurred, if applicable.

Return
String?	This value may be null.

getResultFilePath

Added in API level 35

fun getResultFilePath(): String?

The file path of the profiling result data. Will be null if {@see #getErrorCode} returns code other than {@see #ERROR_NONE}.

getTag

Added in API level 35

fun getTag(): String?

The tag defined by the caller at request time.

Return
String?	This value may be null.

getTriggerType

Added in API level 36

fun getTriggerType(): Int

Trigger type that started this profiling, or ProfilingTrigger.TRIGGER_TYPE_NONE for profiling not started by a trigger.

writeToParcel

Added in API level 35

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest	Parcel: This value cannot be null.
flags	Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 35

static val CREATOR: Parcelable.Creator<ProfilingResult!>