自 2025 年 3 月 27 日起，我們建議您使用 android-latest-release 而非 aosp-main 建構及貢獻 AOSP。詳情請參閱「Android 開放原始碼計畫變更」。

本頁面由 Cloud Translation API 翻譯而成。

ConfigurationDescriptor

public class ConfigurationDescriptor
extends Object

java.lang.Object
↳	com.android.tradefed.config.ConfigurationDescriptor

設定物件：用來說明設定本身的某些層面的物件。例如會員測試套件標記。這個類別無法透過指令列接收選項值。只能直接在 XML 中。

摘要

欄位
`public static final String`	`ACTIVE_PARAMETER_KEY` 設定參數化功能的中繼資料鍵 (選用)。
`public static final String`	`LOCAL_SHARDED_KEY` 用於指定設定是否已分割的中繼資料鍵。
`public static final String`	`MODULE_DIR_PATH_KEY` 設定的中繼資料鍵，可在模組設定中指定模組目錄路徑。
`public static final String`	`PRIORITIZE_HOST_CONFIG_KEY` 設定的中繼資料鍵，用於指定是否優先使用主機設定。

公用建構函式
`ConfigurationDescriptor()`

公用方法
`void`	`addMetadata(String key, values)` 在中繼資料項目中加入更多特定鍵的值。
`void`	`addRerunOption(OptionDef optionDef)` 將選項新增至可用於重新執行測試的選項清單。
`ConfigurationDescriptor`	`clone()` 傳回 `ConfigurationDescriptor` 物件的深層複本。
`static ConfigurationDescriptor`	`fromProto(ConfigurationDescription.Descriptor protoDescriptor)` 從 `toProto()` 執行反向操作，以便取回物件。
`IAbi`	`getAbi()` 如果已知設定執行的 ABI，則會傳回該 ABI，否則傳回空值。
`MultiMap<String, String>`	`getAllMetaData()` 擷取所有已設定的中繼資料，並傳回地圖的副本。
	`getMetaData(String name)` 取得命名中繼資料項目
`String`	`getModuleName()` 傳回模組設定的模組名稱。
	`getRerunOptions()` 取得可用於重播的 `OptionDef` 清單。
`Integer`	`getShardIndex()` 在本機區塊處理期間取得呼叫的區塊索引。
	`getSuiteTags()` 傳回測試所屬套裝組合標記的清單。
`boolean`	`isNotIRemoteTestShardable()` 傳回設定是否應將 IRemoteTest 分割為不同的模組。
`boolean`	`isNotShardable()` 傳回設定是否可作為套件的一部分進行分割
`boolean`	`isNotStrictShardable()` 傳回設定是否可在套件的範圍內進行嚴格分割
	`removeMetadata(String key)` 移除指定中繼資料鍵的追蹤。
`void`	`setAbi(IAbi abi)` 設定要針對哪個 ABI 執行設定。
`void`	`setMetaData(MultiMap<String, String> metadata)`
`void`	`setModuleName(String name)` 如果這項設定代表模組，我們可以設定與模組相關聯的名稱。
`void`	`setNotIRemoteTestShardable(boolean notIRemoteTestShardable)`
`void`	`setSandboxed(boolean useSandboxed)` 設定設定是否會在沙箱模式下執行。
`void`	`setShardIndex(int index)` 在本機區塊處理中設定呼叫的區塊索引。
`void`	`setSuiteTags( suiteTags)` 設定測試所屬的套件標記清單。
`boolean`	`shouldUseSandbox()` 如果應在沙箱模式中執行叫用作業，則傳回「是」。
`ConfigurationDescription.Descriptor`	`toProto()` 將描述符的目前例項轉換為其 proto 格式。

欄位

ACTIVE_PARAMETER_KEY

public static final String ACTIVE_PARAMETER_KEY

設定參數化功能的中繼資料鍵 (選用)。

LOCAL_SHARDED_KEY

public static final String LOCAL_SHARDED_KEY

設定的中繼資料鍵，用於指定該設定已分割。

MODULE_DIR_PATH_KEY

public static final String MODULE_DIR_PATH_KEY

設定的中繼資料鍵，可在模組設定中指定模組目錄路徑。

PRIORITIZE_HOST_CONFIG_KEY

public static final String PRIORITIZE_HOST_CONFIG_KEY

設定的中繼資料鍵，用於指定是否優先採用主機設定。

公用建構函式

ConfigurationDescriptor

public ConfigurationDescriptor ()

公用方法

addMetadata

public void addMetadata (String key, 
                 values)

在中繼資料項目中加入更多特定鍵的值。

參數
`key`	`String`：要新增值的鍵的 `String`。
`values`	：額外值的 `String` 清單。

addRerunOption

public void addRerunOption (OptionDef optionDef)

將選項新增至可用於重新執行測試的選項清單。

參數
`optionDef`	`OptionDef`：測試選項的 `OptionDef` 物件。

clone

public ConfigurationDescriptor clone ()

傳回 ConfigurationDescriptor 物件的深層複本。

傳回
`ConfigurationDescriptor`

fromProto

public static ConfigurationDescriptor fromProto (ConfigurationDescription.Descriptor protoDescriptor)

從 toProto() 執行反向運算，以便取回物件。

參數
`protoDescriptor`	`ConfigurationDescription.Descriptor`

傳回
`ConfigurationDescriptor`

getAbi

public IAbi getAbi ()

如果已知設定執行的 ABI，則會傳回該 ABI；否則會傳回空值。

傳回
`IAbi`

getAllMetaData

public MultiMap<String, String> getAllMetaData ()

擷取所有已設定的中繼資料，並傳回地圖的副本。

傳回
`MultiMap<String, String>`

getMetaData

public  getMetaData (String name)

取得命名中繼資料項目

參數
`name`	`String`

傳回

getModuleName

public String getModuleName ()

傳回模組設定的模組名稱。

傳回
`String`

getRerunOptions

public  getRerunOptions ()

取得可用於重播的 OptionDef 清單。

傳回

getShardIndex

public Integer getShardIndex ()

在本機區塊處理期間取得呼叫的區塊索引。如果沒有分割，則傳回空值。

傳回
`Integer`

getSuiteTags

public  getSuiteTags ()

傳回測試所屬套裝組合標記的清單。

傳回

isNotIRemoteTestShardable

public boolean isNotIRemoteTestShardable ()

傳回設定是否應將 IRemoteTest 分割為不同的模組。

傳回
`boolean`

isNotShardable

public boolean isNotShardable ()

傳回設定是否可作為套件的一部分進行分割

傳回
`boolean`

isNotStrictShardable

public boolean isNotStrictShardable ()

傳回設定是否可嚴格分割，或是否可做為套件的一部分

傳回
`boolean`

removeMetadata

public  removeMetadata (String key)

移除指定中繼資料鍵的追蹤。

參數
`key`	`String`

傳回

setAbi

public void setAbi (IAbi abi)

設定要針對哪個 ABI 執行設定。

參數
`abi`	`IAbi`

setMetaData

public void setMetaData (MultiMap<String, String> metadata)

參數
`metadata`	`MultiMap`

setModuleName

public void setModuleName (String name)

如果這項設定代表模組，我們可以設定與模組相關聯的名稱。

參數
`name`	`String`

setNotIRemoteTestShardable

public void setNotIRemoteTestShardable (boolean notIRemoteTestShardable)

參數
`notIRemoteTestShardable`	`boolean`

setSandboxed

public void setSandboxed (boolean useSandboxed)

設定設定是否會在沙箱模式下執行。

參數
`useSandboxed`	`boolean`

setShardIndex

public void setShardIndex (int index)

在本機區塊處理中設定叫用作業的區塊索引。

參數
`index`	`int`

setSuiteTags

public void setSuiteTags ( suiteTags)

設定測試所屬的套件標記清單。

參數
`suiteTags`

shouldUseSandbox

public boolean shouldUseSandbox ()

如果應在沙箱模式下執行叫用作業，則傳回「是」。否則為 False。

傳回
`boolean`

toProto

public ConfigurationDescription.Descriptor toProto ()

將描述子的目前例項轉換為其 proto 格式。

傳回
`ConfigurationDescription.Descriptor`