JavaHeapDumpRequestBuilder

Added in 1.15.0

Kotlin |Java

@RequiresApi(api = 35)
public final class JavaHeapDumpRequestBuilder extends ProfilingRequestBuilder

java.lang.Object
↳	androidx.core.os.ProfilingRequestBuilder
	↳	androidx.core.os.JavaHeapDumpRequestBuilder

Request builder to create a request for a java heap dump from ProfilingManager.

val listener =
    Consumer<ProfilingResult> { profilingResult ->
        if (profilingResult.errorCode == ProfilingResult.ERROR_NONE) {
            doSomethingWithMyFile(profilingResult.resultFilePath)
        } else {
            doSomethingWithFailure(profilingResult.errorCode, profilingResult.errorMessage)
        }
    }

requestProfiling(
    context,
    JavaHeapDumpRequestBuilder()
        .setBufferSizeKb(123 /* Requested buffer size in KB */)
        .setTag("tag" /* Caller supplied tag for identification */)
        .build(),
    Dispatchers.IO.asExecutor(), // Your choice of executor for the callback to occur on.
    listener,
)

Summary

Public constructors
`JavaHeapDumpRequestBuilder()`

Public methods
`final @NonNull JavaHeapDumpRequestBuilder`	`setBufferSizeKb(int bufferSizeKb)` Set the buffer size in kilobytes for this profiling request.

Inherited methods

From androidx.core.os.ProfilingRequestBuilder

`final @NonNull ProfilingRequest`	`build()` Build the `ProfilingRequest` object which can be used with `requestProfiling` to request profiling.
`final @NonNull JavaHeapDumpRequestBuilder`	`setCancellationSignal(@NonNull CancellationSignal cancellationSignal)` Set a CancellationSignal to request cancellation of the requested trace.
`final @NonNull JavaHeapDumpRequestBuilder`	`setTag(@NonNull String tag)` Add data to help identify the output.

Public constructors

JavaHeapDumpRequestBuilder

Added in 1.15.0

public JavaHeapDumpRequestBuilder()

Public methods

setBufferSizeKb

Added in 1.15.0

public final @NonNull JavaHeapDumpRequestBuilder setBufferSizeKb(int bufferSizeKb)

Set the buffer size in kilobytes for this profiling request.