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() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Boolean	equals(other: Any?) Indicates whether some other object is "equal to" this one.
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.
Int	hashCode() Returns a hash code value for the object.
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

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

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

equals

Added in API level 35

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj	the reference object with which to compare.
other	Any?: This value may be null.

Return
Boolean	true if this object is the same as the obj argument; false otherwise.

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 one of the following: ERROR_NONE ERROR_FAILED_RATE_LIMIT_SYSTEM ERROR_FAILED_RATE_LIMIT_PROCESS ERROR_FAILED_PROFILING_IN_PROGRESS ERROR_FAILED_EXECUTING ERROR_FAILED_POST_PROCESSING ERROR_FAILED_NO_DISK_SPACE 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 getErrorCode returns code other than 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.

hashCode

Added in API level 35

fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Return
Int	a hash code value for this object.

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 the following: PARCELABLE_WRITE_RETURN_VALUE

Properties

CREATOR

Added in API level 35

static val CREATOR: Parcelable.Creator<ProfilingResult!>