Added in API level 35

Summary: Constants | Inherited Constants | Fields | Methods | Inherited Methods

ProfilingResult

Kotlin |Java

public final class ProfilingResult
extends Object implements Parcelable

java.lang.Object
↳	android.os.ProfilingResult

Encapsulates results of a single profiling request operation.

Summary

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

Inherited constants

From interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<ProfilingResult>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`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.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

ERROR_FAILED_EXECUTING

Added in API level 35

public static final int ERROR_FAILED_EXECUTING

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

Constant Value: 4 (0x00000004)

ERROR_FAILED_INVALID_REQUEST

Added in API level 35

public static final int ERROR_FAILED_INVALID_REQUEST

The request failed due to invalid ProfilingRequest.

Constant Value: 7 (0x00000007)

ERROR_FAILED_NO_DISK_SPACE

Added in API level 35

public static final int ERROR_FAILED_NO_DISK_SPACE

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

Constant Value: 6 (0x00000006)

ERROR_FAILED_POST_PROCESSING

Added in API level 35

public static final int ERROR_FAILED_POST_PROCESSING

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

Constant Value: 5 (0x00000005)

ERROR_FAILED_PROFILING_IN_PROGRESS

Added in API level 35

public static final int ERROR_FAILED_PROFILING_IN_PROGRESS

The request was denied due to profiling already in progress.

Constant Value: 3 (0x00000003)

ERROR_FAILED_RATE_LIMIT_PROCESS

Added in API level 35

public static final int ERROR_FAILED_RATE_LIMIT_PROCESS

The request was denied due to process level rate limiting.

Constant Value: 2 (0x00000002)

ERROR_FAILED_RATE_LIMIT_SYSTEM

Added in API level 35

public static final int ERROR_FAILED_RATE_LIMIT_SYSTEM

The request was denied due to system level rate limiting.

Constant Value: 1 (0x00000001)

ERROR_NONE

Added in API level 35

public static final int ERROR_NONE

The request was executed and succeeded.

Constant Value: 0 (0x00000000)

ERROR_UNKNOWN

Added in API level 35

public static final int ERROR_UNKNOWN

The request was denied or failed for an unspecified reason.

Constant Value: 8 (0x00000008)

Fields

CREATOR

Added in API level 35

public static final Creator<ProfilingResult> CREATOR

Public methods

describeContents

Added in API level 35

public int describeContents ()

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(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

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

getErrorCode

Added in API level 35

public int getErrorCode ()

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

Returns
`int`	Value is `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`, or `ERROR_UNKNOWN`

getErrorMessage

Added in API level 35

public String getErrorMessage ()

Additional details about failures that occurred, if applicable.

Returns
`String`	This value may be `null`.

getResultFilePath

Added in API level 35

public String getResultFilePath ()

The file path of the profiling result data. Will be null if returns code other than .

Returns
`String`

See also:

getErrorCode()
ERROR_NONE

getTag

Added in API level 35

public String getTag ()

The tag defined by the caller at request time.

Returns
`String`	This value may be `null`.

getTriggerType

Added in Android Baklava

public int getTriggerType ()

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

Returns
`int`

writeToParcel

Added in API level 35

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES