12.5. リソース属性の詳細

access-type

属性が読み取り専用、読み書き可能、またはメトリックであるか。有効な値は read-only、read-write、および metric です。metric は、値が永続設定に保存されず、サーバーの活動によって変更する可能性がある読み取り専用属性です。

allowed

有効な値のリスト。

alternatives

属性間の排他的な関係を定義します。この属性の値が設定されている場合、これらの属性が必要であることを示しても、alternatives フィールドに表示された属性は未定義である必要があります。

capability-reference

この属性の値が、別のリソースによって提供される指定機能の名前の動的部分を指定すること示します。これは、属性が管理モデルの別領域への参照であることを示します。

default

値が提供されなかった場合に属性に使用するデフォルト値。

description

属性のテキストでの詳細。

deprecated

この属性が非推奨となったかどうか。また、非推奨となったバージョンや非推奨となった理由も提供します。

expressions-allowed

属性の値として式を使用できるかどうか。

max

数値属性の最大値。

max-length

STRING、LIST、または BYTES 型の属性の最大長。

min

数値属性の最小値。

min-length

STRING、LIST、または BYTES 型の属性の最小長。

nillable

定義された値のない属性を受け入れるかどうか。値の定義が必要ない場合、または必要でも代替の値が定義されている場合に、属性を未定義にすることができます。このフィールドを使用すると、未定義の値の可能性に対応する必要があるかどうかを簡単に理解することができます。

required

属性に定義された値が必要であるかどうか。true の場合、値または代替を定義する必要があります。false の場合はを未定義にすることができます。

requires

属性に定義された値がある場合、このリストに定義された属性にも値がなければならないことを示します。

restart-required

write-attribute 操作の実行時に再起動しなければならないサービスを定義します。このフィールドには以下の値を使用できます。

storage

属性の値が永続設定ファイルに保存されるか、リソースの実行中のみ存在するか。値は configuration または runtime になります。

type

属性値の型。許可される値は BIG_DECIMAL、BIG_INTEGER、BOOLEAN、BYTES、DOUBLE、INT、LIST、LONG、OBJECT、PROPERTY、および STRING です。

value-type

LIST または OBJECT 型の属性の追加の型情報を定義します。LIST 属性の INT の value-type は Java の List<Integer> と似ています。OBJECT 属性の STRING の value-type は Java の Map<String, String> と似ています。OBJECT 属性のすべての要素が同じ型でない場合、value-type はオブジェクトのフィールドと値を定義する完全定義の複合オブジェクトを表します。

unit

属性の値の単位 (該当する場合)。