自 2025 年 3 月 27 日起，我们建议您使用 android-latest-release 而非 aosp-main 构建 AOSP 并为其做出贡献。如需了解详情，请参阅 AOSP 的变更。

此页面由 Cloud Translation API 翻译。

CommandOptions

public class CommandOptions
extends Object implements ICommandOptions

java.lang.Object
↳	com.android.tradefed.command.CommandOptions

ICommandOptions 的实现。

摘要

字段
`public static final String`	`DRY_RUN_OPTION`
`public static final String`	`ENABLE_SANDBOX_TEST_MODE`
`public static final String`	`INVOCATION_DATA`
`public static final String`	`NOISY_DRY_RUN_OPTION`
`public static final String`	`TEST_TAG_OPTION`
`public static final String`	`USE_REMOTE_SANDBOX`
`public static final String`	`USE_SANDBOX`

公共构造函数
`CommandOptions()`

公共方法
`boolean`	`captureLogcatOnFailure()` 是否在测试用例失败时捕获 logcat
`boolean`	`captureScreenshotOnFailure()` 是否在测试用例失败时截取屏幕截图
`ICommandOptions`	`clone()`
`boolean`	`earlyDeviceRelease()` 是否在使用完设备后提前释放设备。
`boolean`	`filterPreviousPassedTests()` 是否过滤上次尝试中已通过的测试用例。
	`getAutoLogCollectors()` 返回要为调用添加的一组自动日志收集器
	`getDynamicDownloadArgs()` 返回要传递给动态下载查询的参数映射。
`int`	`getExtraRemotePostsubmitInstance()` 在提交后是否在远程虚拟机中启动额外实例。
`String`	`getHostLogSuffix()` 返回要附加到 Tradefed host_log 的后缀，如果没有前缀，则返回 null。
`UniqueMultiMap<String, String>`	`getInvocationData()` 返回传递给调用的描述数据
`long`	`getInvocationTimeout()` 返回指定的调用超时时间。
`long`	`getLoopTime()` 获取重新调度此命令之前需要等待的时间。
`long`	`getMaxLoopCount()` 返回安排命令的次数上限。
`boolean`	`getOptimizeMainlineTest()` 如果我们应优化 Mainline 测试的测试模块列表，则返回 true。
`Duration`	`getParallelSetupTimeout()` 返回在并行设置期间要使用的超时时间。
`Integer`	`getShardCount()` 返回该命令的总分片数。
`Integer`	`getShardIndex()` 返回命令的分片编号。
`String`	`getTestTag()` 返回调用的测试标记。
`String`	`getTestTagSuffix()` 返回要附加到 test-tag 以表示某个测试的某些变体的 test-tag 后缀。
`boolean`	`isDryRunMode()` 如果应跳过将此命令添加到队列，请返回 `true`。
`boolean`	`isFullHelpMode()` 如果已请求完整详细帮助模式，则返回 `true`
`boolean`	`isHelpMode()` 如果已请求缩写帮助模式，则返回 `true`
`boolean`	`isLoopMode()` 返回配置的循环模式。
`boolean`	`isNoisyDryRunMode()` 如果我们应先将命令输出到控制台，然后再跳过将其添加到队列，请返回 `true`。
`boolean`	`reportInvocationComplete()` 是否在 invocationComplete 之前报告日志。
`boolean`	`reportPassedTests()` 是否报告通过的测试用例。
`boolean`	`reportTestCaseCount()` 是否报告每个测试类型的测试用例数量。
	`reportingTags()` 用于生成与调用相关的报告的标签列表。
`boolean`	`runOnAllDevices()` 如果命令应在所有设备上运行，则返回 true。
`void`	`setAutoLogCollectors( autoLogCollectors)` 设置应添加到调用的一组自动日志收集器。
`void`	`setBugreportOnInvocationEnded(boolean takeBugreport)` 设置是否在调用结束时捕获 bug 报告。
`void`	`setBugreportzOnInvocationEnded(boolean takeBugreportz)` 设置是否在调用结束时捕获 bugreportz。
`void`	`setHostLogSuffix(String suffix)` 设置要附加到 Tradefed host_log 的后缀。
`void`	`setInvocationTimeout(Long invocationTimeout)` 设置调用超时。
`void`	`setLoopMode(boolean loopMode)` 为配置设置循环模式。
`void`	`setReplicateSetup(boolean replicate)` 设置是否使用复制设置。
`void`	`setReportInvocationComplete(boolean reportInvocationCompleteLogs)` 设置是否在 invocationComplete 之前报告日志
`void`	`setReportTestCaseCount(boolean report)` 设置是否按测试类型报告测试用例数。
`void`	`setShardCount(Integer shardCount)` 设置命令的分片数。
`void`	`setShardIndex(Integer shardIndex)` 设置命令的分片编号。
`void`	`setShouldUseSandboxing(boolean use)` 设置是否应使用 TF 容器
`void`	`setTestTag(String testTag)` 为调用设置测试标记。
`void`	`setUseSandboxTestMode(boolean use)` 设置是否应使用 TF 沙盒测试模式。
`boolean`	`shouldDisableInvocationSetupAndTeardown()` 是否停用调用前设置和调用后拆解。
`boolean`	`shouldReportModuleProgression()` 是否在模块级报告远程调用的进度。
`boolean`	`shouldUseDynamicSharding()` 返回是否应使用动态分片
`boolean`	`shouldUseParallelRemoteSetup()` 是否尝试并行设置远程设备。
`boolean`	`shouldUseParallelSetup()` 是否尝试并行设置。
`boolean`	`shouldUseRemoteSandboxMode()` 是否在远程调用中使用沙盒模式。
`boolean`	`shouldUseReplicateSetup()` 是否为所有远程设备使用复制设置。
`boolean`	`shouldUseSandboxTestMode()` 如果我们应在测试模式下使用 Tf 沙盒，则返回 true。
`boolean`	`shouldUseSandboxing()` 如果我们应使用 Tf 容器运行调用，则返回 true
`boolean`	`shouldUseTokenSharding()` 分片是否应使用令牌支持。
`boolean`	`takeBugreportOnInvocationEnded()` 如果应在测试调用结束时获取 bug 报告，则返回 true。
`boolean`	`takeBugreportzOnInvocationEnded()` 如果在测试调用最终 bugreport 期间应获取 bugreportz 而非 bugreport，则返回 true。

字段

DRY_RUN_OPTION

public static final String DRY_RUN_OPTION

ENABLE_SANDBOX_TEST_MODE

public static final String ENABLE_SANDBOX_TEST_MODE

INVOCATION_DATA

public static final String INVOCATION_DATA

NOISY_DRY_RUN_OPTION

public static final String NOISY_DRY_RUN_OPTION

TEST_TAG_OPTION

public static final String TEST_TAG_OPTION

USE_REMOTE_SANDBOX

public static final String USE_REMOTE_SANDBOX

USE_SANDBOX

public static final String USE_SANDBOX

公共构造函数

CommandOptions

public CommandOptions ()

公共方法

captureLogcatOnFailure

public boolean captureLogcatOnFailure ()

是否在测试用例失败时捕获 logcat

返回
`boolean`

captureScreenshotOnFailure

public boolean captureScreenshotOnFailure ()

是否在测试用例失败时截取屏幕截图

返回
`boolean`

clone

public ICommandOptions clone ()

返回
`ICommandOptions`

earlyDeviceRelease

public boolean earlyDeviceRelease ()

是否在使用完设备后提前释放设备。

返回
`boolean`

filterPreviousPassedTests

public boolean filterPreviousPassedTests ()

是否过滤上次尝试中已通过的测试用例。

返回
`boolean`

getAutoLogCollectors

public  getAutoLogCollectors ()

返回要为调用添加的一组自动日志收集器

返回

getDynamicDownloadArgs

public  getDynamicDownloadArgs ()

返回要传递给动态下载查询的参数映射。

返回

getExtraRemotePostsubmitInstance

public int getExtraRemotePostsubmitInstance ()

在提交后，是否在远程虚拟机中启动额外实例。

返回
`int`

getHostLogSuffix

public String getHostLogSuffix ()

返回要附加到 Tradefed host_log 的后缀，如果没有前缀，则返回 null。

返回
`String`

getInvocationData

public UniqueMultiMap<String, String> getInvocationData ()

返回传递给调用的描述数据

返回
`UniqueMultiMap<String, String>`

getInvocationTimeout

public long getInvocationTimeout ()

返回指定的调用超时时间。如果不使用超时，则为 0。

返回
`long`

getLoopTime

public long getLoopTime ()

获取重新调度此命令之前需要等待的时间。

返回
`long`	时间（毫秒）

getMaxLoopCount

public long getMaxLoopCount ()

返回安排命令的次数上限。如果 isLoopMode 为 false，则没有任何影响。

返回
`long`

getOptimizeMainlineTest

public boolean getOptimizeMainlineTest ()

如果我们应优化 Mainline 测试的测试模块列表，则返回 true。

返回
`boolean`

getParallelSetupTimeout

public Duration getParallelSetupTimeout ()

返回在并行设置期间要使用的超时时间。

返回
`Duration`

getShardCount

public Integer getShardCount ()

返回该命令的总分片数。

返回
`Integer`

getShardIndex

public Integer getShardIndex ()

返回命令的分片编号。

返回
`Integer`

getTestTag

public String getTestTag ()

返回调用的测试标记。如果未指定，则默认为“stub”。

返回
`String`

getTestTagSuffix

public String getTestTagSuffix ()

返回要附加到 test-tag 以表示某个测试的某些变体的 test-tag 后缀。

返回
`String`

isDryRunMode

public boolean isDryRunMode ()

如果应跳过将此命令添加到队列，则返回 true。

返回
`boolean`

isFullHelpMode

public boolean isFullHelpMode ()

如果已请求完整详细帮助模式，则返回 true

返回
`boolean`

isHelpMode

public boolean isHelpMode ()

如果已请求缩写帮助模式，则返回 true

返回
`boolean`

isLoopMode

public boolean isLoopMode ()

返回配置的循环模式。

返回
`boolean`

isNoisyDryRunMode

public boolean isNoisyDryRunMode ()

如果应先将命令输出到控制台，然后再跳过将其添加到队列，请返回 true。

返回
`boolean`

reportInvocationComplete

public boolean reportInvocationComplete ()

是否在 invocationComplete 之前报告日志。

返回
`boolean`

reportPassedTests

public boolean reportPassedTests ()

是否报告通过的测试用例。

返回
`boolean`

reportTestCaseCount

public boolean reportTestCaseCount ()

是否报告每种测试类型的测试用例数量。

返回
`boolean`

reportingTags

public  reportingTags ()

用于生成与调用相关的报告的标记列表。

返回

runOnAllDevices

public boolean runOnAllDevices ()

如果命令应在所有设备上运行，则返回 true。

返回
`boolean`

setAutoLogCollectors

public void setAutoLogCollectors ( autoLogCollectors)

设置应添加到调用的一组自动日志收集器。

参数
`autoLogCollectors`

setBugreportOnInvocationEnded

public void setBugreportOnInvocationEnded (boolean takeBugreport)

设置是否在调用结束时捕获 bug 报告。

参数
`takeBugreport`	`boolean`

setBugreportzOnInvocationEnded

public void setBugreportzOnInvocationEnded (boolean takeBugreportz)

设置是否在调用结束时捕获 bugreportz。

参数
`takeBugreportz`	`boolean`

setHostLogSuffix

public void setHostLogSuffix (String suffix)

设置要附加到 Tradefed host_log 的后缀。

参数
`suffix`	`String`

setInvocationTimeout

public void setInvocationTimeout (Long invocationTimeout)

设置调用超时。如果不使用超时，则为 0。

参数
`invocationTimeout`	`Long`

setLoopMode

public void setLoopMode (boolean loopMode)

为配置设置循环模式。

setReplicateSetup

public void setReplicateSetup (boolean replicate)

设置是否使用复制设置。

参数
`replicate`	`boolean`

setReportInvocationComplete

public void setReportInvocationComplete (boolean reportInvocationCompleteLogs)

设置是否在 invocationComplete 之前报告日志

参数
`reportInvocationCompleteLogs`	`boolean`

setReportTestCaseCount

public void setReportTestCaseCount (boolean report)

设置是否按测试类型报告测试用例数。

参数
`report`	`boolean`

setShardCount

public void setShardCount (Integer shardCount)

设置命令的分片数。

参数
`shardCount`	`Integer`

setShardIndex

public void setShardIndex (Integer shardIndex)

设置命令的分片编号。

参数
`shardIndex`	`Integer`

setShouldUseSandboxing

public void setShouldUseSandboxing (boolean use)

设置是否应使用 TF 容器

参数
`use`	`boolean`

setTestTag

public void setTestTag (String testTag)

为调用设置测试标记。

setUseSandboxTestMode

public void setUseSandboxTestMode (boolean use)

设置是否应使用 TF 沙盒测试模式。

参数
`use`	`boolean`

shouldDisableInvocationSetupAndTeardown

public boolean shouldDisableInvocationSetupAndTeardown ()

是否停用调用前设置和调用后拆解。

返回
`boolean`

shouldReportModuleProgression

public boolean shouldReportModuleProgression ()

是否在模块级报告远程调用的进度。

返回
`boolean`

shouldUseDynamicSharding

public boolean shouldUseDynamicSharding ()

返回是否应使用动态分片

返回
`boolean`

shouldUseParallelRemoteSetup

public boolean shouldUseParallelRemoteSetup ()

是否尝试并行设置远程设备。

返回
`boolean`

shouldUseParallelSetup

public boolean shouldUseParallelSetup ()

是否尝试并行设置。

返回
`boolean`

shouldUseRemoteSandboxMode

public boolean shouldUseRemoteSandboxMode ()

是否在远程调用中使用沙盒模式。

返回
`boolean`

shouldUseReplicateSetup

public boolean shouldUseReplicateSetup ()

是否为所有远程设备使用复制设置。

返回
`boolean`

shouldUseSandboxTestMode

public boolean shouldUseSandboxTestMode ()

如果我们应在测试模式下使用 Tf 沙盒，则返回 true。

返回
`boolean`

shouldUseSandboxing

public boolean shouldUseSandboxing ()

如果应使用 Tf 容器运行调用，则返回 true

返回
`boolean`

shouldUseTokenSharding

public boolean shouldUseTokenSharding ()

分片是否应使用令牌支持。

返回
`boolean`

takeBugreportOnInvocationEnded

public boolean takeBugreportOnInvocationEnded ()

如果应在测试调用结束时获取 bug 报告，则返回 true。

返回
`boolean`

takeBugreportzOnInvocationEnded

public boolean takeBugreportzOnInvocationEnded ()

如果在测试调用最终 bugreport 期间应获取 bugreportz 而非 bugreport，则返回 true。

返回
`boolean`