インデックス
カスタム Big Object 内に定義されたインデックスを表します。カスタム Big Object の複合主キー (インデックス) を定義するには、このメタデータ型を使用します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
インデックスは Big Object のカスタムオブジェクト定義の一部で、ユーザが定義します。詳細は、「CustomObject」を参照してください。
バージョン
Index 型は、API バージョン 41.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| fields | IndexField[] | インデックスの項目の定義。 |
| label | string | 必須。この名前は、ユーザインターフェースで Big Object を参照するために使用します。API バージョン 41.0 以降で利用できます。 |
IndexField
インデックスを構成する項目、順序、並び替え方向を定義します。項目を定義する順序によって、インデックスにリストされる項目の順序が決まります。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| name | string | 必須。インデックスに含まれる項目の API 参照名。この値は、項目セクションの対応する項目の fullName の値と一致していて、必須として���ークされている必要があります。 |
| sortDirection | string | 必須。インデックスの項目の並び替え方向。有効な値は、ASC (昇順) と DESC (降順) です。 |
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) はサポートされません。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。