EntityRemoveLabelsByUniqueAttribute interface
メソッド
| delete(Entity |
型と一意の属性によって識別される特定のエンティティに対して、指定されたラベルを削除します。 ラベルが null/空の場合、ラベルは削除されません。 ラベル セット内のラベルが既存でないラベルの場合は無視され、既存のラベルのみが削除されます。 typeName パス パラメーターに加えて、属性キーと値のペアは、attr:<attrName>=<attrValue>の形式で指定できます。 注: attrName と attrValue は、エンティティ間で一意である必要があります。たとえば、qualifiedName。 REST 要求は、DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue のようになります。 |
| post(Entity |
型と一意の属性によって識別される特定のエンティティにラベルを設定します。 ラベルが null/空の場合、既存のラベルはすべて削除されます。 typeName パス パラメーターに加えて、属性キーと値のペアは、attr:<attrName>=<attrValue>の形式で指定できます。 注: attrName と attrValue は、エンティティ間で一意である必要があります。たとえば、qualifiedName。 REST 要求は、POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue のようになります。 |
| put(Entity |
型と一意の属性によって識別される特定のエンティティに、指定されたラベルを追加します。 ラベルが null/空の場合、ラベルは追加されません。 typeName パス パラメーターに加えて、属性キーと値のペアは、attr:<attrName>=<attrValue>の形式で指定できます。 注: attrName と attrValue は、エンティティ間で一意である必要があります。たとえば、qualifiedName。 REST 要求は、PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue のようになります。 |
メソッドの詳細
delete(EntityRemoveLabelsByUniqueAttributeParameters)
型と一意の属性によって識別される特定のエンティティに対して、指定されたラベルを削除します。
ラベルが null/空の場合、ラベルは削除されません。
ラベル セット内のラベルが既存でないラベルの場合は無視され、既存のラベルのみが削除されます。 typeName パス パラメーターに加えて、属性キーと値のペアは、attr:<attrName>=<attrValue>の形式で指定できます。 注: attrName と attrValue は、エンティティ間で一意である必要があります。たとえば、qualifiedName。 REST 要求は、DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue のようになります。
function delete(options?: EntityRemoveLabelsByUniqueAttributeParameters): StreamableMethod<EntityRemoveLabelsByUniqueAttribute204Response | EntityRemoveLabelsByUniqueAttributeDefaultResponse>パラメーター
戻り値
post(EntitySetLabelsByUniqueAttributeParameters)
型と一意の属性によって識別される特定のエンティティにラベルを設定します。
ラベルが null/空の場合、既存のラベルはすべて削除されます。
typeName パス パラメーターに加えて、属性キーと値のペアは、attr:<attrName>=<attrValue>の形式で指定できます。
注: attrName と attrValue は、エンティティ間で一意である必要があります。たとえば、qualifiedName。
REST 要求は、POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue のようになります。
function post(options?: EntitySetLabelsByUniqueAttributeParameters): StreamableMethod<EntitySetLabelsByUniqueAttribute204Response | EntitySetLabelsByUniqueAttributeDefaultResponse>パラメーター
戻り値
put(EntityAddLabelsByUniqueAttributeParameters)
型と一意の属性によって識別される特定のエンティティに、指定されたラベルを追加します。
ラベルが null/空の場合、ラベルは追加されません。
typeName パス パラメーターに加えて、属性キーと値のペアは、attr:<attrName>=<attrValue>の形式で指定できます。
注: attrName と attrValue は、エンティティ間で一意である必要があります。たとえば、qualifiedName。
REST 要求は、PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue のようになります。
function put(options?: EntityAddLabelsByUniqueAttributeParameters): StreamableMethod<EntityAddLabelsByUniqueAttribute204Response | EntityAddLabelsByUniqueAttributeDefaultResponse>