Momento CacheのためのSet APIについて
集合は要素の集まりですが、各要素は一度しか現れず、順序は保証されません。
例: セットが [1, 2, 3]
を含み、2 を追加してもセットは [1, 2, 3].
のままです。
詳しくは、Setsを参照してください。
Set methods
SetAddElement
セットに要素を追加します。セット項目がまだ存在しない場合、このメソッドはそれを作成します。
名前 | 型 | 詳細 |
---|---|---|
cacheName | String | キャッシュの名前。 |
setName | String | 変更するセットアイテムの名前。 |
element | String | Bytes | この操作によって追加される要素。 |
ttl | CollectionTTL object | キャッシュに設定された項目の TTLです。この TTL は、キャッシュ接続クライアントを初期化するときに使用される TTL よりも優先されます。 |
Method response object
- Success
- Error
詳しくはレスポンスオブジェクトを参照してください。
- JavaScript
const result = await cacheClient.setAddElement('test-cache', 'test-set', 'test-element');
if (result instanceof CacheSetAddElement.Success) {
console.log("Element added successfully to set 'test-set'");
} else if (result instanceof CacheSetAddElement.Error) {
throw new Error(
`An error occurred while attempting to call cacheSetAddElement on set 'test-set' in cache 'test-cache': ${result.errorCode()}: ${result.toString()}`
);
}
SetAddElements
Adds multiple elements to a set item.
名前 | 型 | 詳細 |
---|---|---|
cacheName | String | キャッシュの名前。 |
setName | String | 変更するセットアイテムの名前。 |
elements | String[] | Bytes[] | この操作によって追加される要素。 |
ttl | CollectionTTL object | キャッシュに設定された項目の TTLです。この TTL は、キャッシュ接続クライアントを初期化するときに使用される TTL よりも優先されます。 |
Method response object
- Success
- Error
詳しくはレスポンスオブジェクトを参照してください。
- JavaScript
const result = await cacheClient.setAddElements('test-cache', 'test-set', ['test-element1', 'test-element2']);
if (result instanceof CacheSetAddElements.Success) {
console.log("Elements added successfully to set 'test-set'");
} else if (result instanceof CacheSetAddElements.Error) {
throw new Error(
`An error occurred while attempting to call cacheSetAddElements on set 'test-set' in cache 'test-cache': ${result.errorCode()}: ${result.toString()}`
);
}
SetFetch
Gets a set item from a cache.
名前 | 型 | 詳細 |
---|---|---|
cacheName | String | キャッシュの名前。 |
setName | String | 取得するセットアイテムの名前。 |
Method response object
SetFetch のレスポンスオブジェクトは、キャッシュヒット、ミス、エラーの3つの可能なオプションを返します。
- Hit
- valueSetBytes(): Bytes[]
- valueSetString(): String[]
- toString(): String
- Miss
- Error
詳しくはレスポンスオブジェクトを参照してください。
- JavaScript
await cacheClient.setAddElements('test-cache', 'test-set', ['test-element1', 'test-element2']);
const result = await cacheClient.setFetch('test-cache', 'test-set');
if (result instanceof CacheSetFetch.Hit) {
console.log('Set fetched successfully- ');
result.valueSet().forEach((value, key) => {
console.log(`${key} : ${value}`);
});
} else if (result instanceof CacheSetFetch.Miss) {
console.log("Set 'test-set' was not found in cache 'test-cache'");
} else if (result instanceof CacheSetFetch.Error) {
throw new Error(
`An error occurred while attempting to call cacheSetFetch on set 'test-set' in cache 'test-cache': ${result.errorCode()}: ${result.toString()}`
);
}
SetRemoveElement
既存のセット項目から単一の要素を削除します。
名前 | 型 | 詳細 |
---|---|---|
cacheName | String | キャッシュの名前。 |
setName | String | 変更するセットアイテムの名前。 |
element | String | Bytes | この操作によって削除される要素。 |
Method response object
- Success
- Error
詳しくはレスポンスオブジェクトを参照してください。
- JavaScript
await cacheClient.setAddElement('test-cache', 'test-set', 'test-element');
const result = await cacheClient.setRemoveElement('test-cache', 'test-set', 'test-element');
if (result instanceof CacheSetRemoveElement.Success) {
console.log("Element 'test-element' removed successfully from set 'test-set'");
} else if (result instanceof CacheSetRemoveElement.Error) {
throw new Error(
`An error occurred while attempting to call cacheSetRemoveElement on set 'test-set' in cache 'test-cache': ${result.errorCode()}: ${result.toString()}`
);
}
SetRemoveElements
既存のセットアイテムから複数の要素を削除します。
名前 | 型 | 詳細 |
---|---|---|
cacheName | String | キャッシュの名前。 |
setName | String | 変更するセットアイテムの名前。 |
elements | String[] | Bytes[] | この操作によって削除される要素。 |
Method response object
- Success
- Error
詳しくはレスポンスオブジェクトを参照してください。
- JavaScript
await cacheClient.setAddElements('test-cache', 'test-set', ['test-element1', 'test-element2']);
const result = await cacheClient.setRemoveElements('test-cache', 'test-set', ['test-element1', 'test-element2']);
if (result instanceof CacheSetRemoveElements.Success) {
console.log("Elements 'test-element1' and 'test-element2' removed successfully from set 'test-set'");
} else if (result instanceof CacheSetRemoveElements.Error) {
throw new Error(
`An error occurred while attempting to call cacheSetRemoveElements on set 'test-set' in cache 'test-cache': ${result.errorCode()}: ${result.toString()}`
);
}
SetContainsElement
指定された要素が指定されたセットに含まれるかどうかを調べます。
名前 | 型 | 詳細 |
---|---|---|
cacheName | String | キャッシュの名前。 |
setName | String | セットアイテムの名前。 |
element | String | Bytes | 存在をチェックする要素の名前。 |
Method response object
SetContainsElementのレスポンスオブジェクトは、キャッシュヒット、ミス、エラーの3つの可能なオプションを返します。
- Hit
- containsElement(): bool
- Miss
- Error
詳しくはレスポンスオブジェクトを参照してください。
SetContainsElements
指定された要素が指定されたセットに含まれるかどうかをチェックします。
名前 | 型 | 詳細 |
---|---|---|
cacheName | String | キャッシュの名前。 |
setName | String | セットアイテムの名前。 |
elements | String[] | Bytes[] | 存在をチェックする要素名の配列。 |
Method response object
SetContainsElementsのレスポンスオブジェクトは、キャッシュヒット、ミス、エラーの3つの可能なオプションを返します。
- Hit
- containsElements(): bool[]
- Miss
- Error
詳しくはレスポンスオブジェクトを参照してください。
SetLength
既存のセットアイテムの長さを取得します。
名前 | 型 | 詳細 |
---|---|---|
cacheName | String | キャッシュの名前。 |
setName | String | チェックするセットアイテムの名前。 |
Method response object
- Hit
length()
: Number
- Miss
- Error
詳しくはレスポンスオブジェクトを参照してください。