Starting March 27, 2025, we recommend using android-latest-release instead of aosp-main to build and contribute to AOSP. For more information, see Changes to AOSP.

SandboxOptions

public final class SandboxOptions
extends Object

java.lang.Object
↳	com.android.tradefed.sandbox.SandboxOptions

Class that can receive and provide options to a ISandbox.

Summary

Fields
`public static final String`	`CHILD_GLOBAL_CONFIG`
`public static final String`	`ENABLE_DEBUG_THREAD`
`public static final String`	`PARENT_PREPARER_CONFIG`
`public static final String`	`SANDBOX_BUILD_ID`
`public static final String`	`TF_LOCATION`
`public static final String`	`USE_PROTO_REPORTER`
`public static final String`	`WAIT_FOR_EVENTS_TIMEOUT`

Public constructors
`SandboxOptions()`

Public methods
`boolean`	`delayDownloadAfterSharding()` Returns whether or not to delay download after the sharding.
`boolean`	`downloadDefaultZips()` Returns whether or not to download the default tests zips.
`boolean`	`dumpTestTemplate()` Returns whether or not to dump the test template in fallback mode.
`String`	`getChildGlobalConfig()` Returns the configuration to be used for the child sandbox.
	`getEnvVariables()` The map of environment variable to pass to the java process of the sandbox.
	`getForcePartialDownloadFileRegexList()` Returns a set of regex, sandbox partial download will always download those files that match the regex
	`getJavaOptions()` The list of options to pass the java process of the sandbox.
`String`	`getParentPreparerConfig()` Returns the configuration which preparer should run in the parent process of the sandbox.
`String`	`getSandboxBuildId()` Returns the build-id forced for the sandbox to be used during the run.
`File`	`getSandboxTfDirectory()` Returns the provided directories containing the Trade Federation version to use for sandboxing the run.
	`getTestsZips()` Returns the set of tests zips to stage for the sandbox.
`long`	`getWaitForEventsTimeout()` Returns the time we should wait for events to be processed after the sandbox is done running.
`boolean`	`shouldEnableDebugThread()` Enable a debug thread.
`boolean`	`shouldParallelSetup()` Returns whether or not to execute the sandbox setup in parallel.
`boolean`	`shouldUseParallelDownload()` Returns whether or not to use parallel download during setup.
`boolean`	`shouldUsePartialDownload()` Returns whether or not to use partial download caching
`boolean`	`shouldUseProtoReporter()` Returns whether or not protobuf reporting should be used.
`boolean`	`shouldUseSplitDiscovery()` Returns whether to use setup with independent discovery.
`boolean`	`shouldUseTestDiscovery()` Returns whether or not to use tradefed observatory to optimize jar staging
`boolean`	`startAvdInParent()` Returns whether or not to start avd devices in parent sandbox or let it be in child.

Fields

CHILD_GLOBAL_CONFIG

public static final String CHILD_GLOBAL_CONFIG

ENABLE_DEBUG_THREAD

public static final String ENABLE_DEBUG_THREAD

PARENT_PREPARER_CONFIG

public static final String PARENT_PREPARER_CONFIG

SANDBOX_BUILD_ID

public static final String SANDBOX_BUILD_ID

TF_LOCATION

public static final String TF_LOCATION

USE_PROTO_REPORTER

public static final String USE_PROTO_REPORTER

WAIT_FOR_EVENTS_TIMEOUT

public static final String WAIT_FOR_EVENTS_TIMEOUT

Public constructors

SandboxOptions

public SandboxOptions ()

Public methods

delayDownloadAfterSharding

public boolean delayDownloadAfterSharding ()

Returns whether or not to delay download after the sharding.

Returns
`boolean`

downloadDefaultZips

public boolean downloadDefaultZips ()

Returns whether or not to download the default tests zips.

Returns
`boolean`

dumpTestTemplate

public boolean dumpTestTemplate ()

Returns whether or not to dump the test template in fallback mode.

Returns
`boolean`

getChildGlobalConfig

public String getChildGlobalConfig ()

Returns the configuration to be used for the child sandbox. Or null if the parent one should be used.

Returns
`String`

getEnvVariables

public  getEnvVariables ()

The map of environment variable to pass to the java process of the sandbox.

Returns

getForcePartialDownloadFileRegexList

public  getForcePartialDownloadFileRegexList ()

Returns a set of regex, sandbox partial download will always download those files that match the regex

Returns

getJavaOptions

public  getJavaOptions ()

The list of options to pass the java process of the sandbox.

Returns

getParentPreparerConfig

public String getParentPreparerConfig ()

Returns the configuration which preparer should run in the parent process of the sandbox.

Returns
`String`

getSandboxBuildId

public String getSandboxBuildId ()

Returns the build-id forced for the sandbox to be used during the run.

Returns
`String`

getSandboxTfDirectory

public File getSandboxTfDirectory ()

Returns the provided directories containing the Trade Federation version to use for sandboxing the run.

Returns
`File`

getTestsZips

public  getTestsZips ()

Returns the set of tests zips to stage for the sandbox.

Returns

getWaitForEventsTimeout

public long getWaitForEventsTimeout ()

Returns the time we should wait for events to be processed after the sandbox is done running.

Returns
`long`

shouldEnableDebugThread

public boolean shouldEnableDebugThread ()

Enable a debug thread.

Returns
`boolean`

shouldParallelSetup

public boolean shouldParallelSetup ()

Returns whether or not to execute the sandbox setup in parallel.

Returns
`boolean`

shouldUseParallelDownload

public boolean shouldUseParallelDownload ()

Returns whether or not to use parallel download during setup.

Returns
`boolean`

shouldUsePartialDownload

public boolean shouldUsePartialDownload ()

Returns whether or not to use partial download caching

Returns
`boolean`

shouldUseProtoReporter

public boolean shouldUseProtoReporter ()

Returns whether or not protobuf reporting should be used.

Returns
`boolean`

shouldUseSplitDiscovery

public boolean shouldUseSplitDiscovery ()

Returns whether to use setup with independent discovery.

Returns
`boolean`

shouldUseTestDiscovery

public boolean shouldUseTestDiscovery ()

Returns whether or not to use tradefed observatory to optimize jar staging

Returns
`boolean`

startAvdInParent

public boolean startAvdInParent ()

Returns whether or not to start avd devices in parent sandbox or let it be in child.

Returns
`boolean`