feat: add examples for CollectionTtl [ja] (#515)

* feat: add examples for CollectionTtl [ja] * translate ja * fix typo --------- Co-authored-by: GitHub <[email protected]> Co-authored-by: Yoshiitaka <[email protected]>
momentohq · Dec 6, 2023 · 22a63a5 · 22a63a5
1 parent 5dd6dc6
commit 22a63a5
Show file tree

Hide file tree

Showing 5 changed files with 93 additions and 34 deletions.
diff --git a/...aurus-plugin-content-docs/current/cache/develop/api-reference/collection-ttl.md b/...aurus-plugin-content-docs/current/cache/develop/api-reference/collection-ttl.md
@@ -1,58 +1,85 @@
 ---
 sidebar_position: 10
 sidebar_label: CollectionTTL object
-title: CollectionTTL API リファレンス
-description: Momento Cache の CollectionTTL オブジェクトとのやり取り方法を学びましょう。
+title: CollectionTTL API reference
+description: Learn how to interact with the CollectionTTL object in Momento Cache.
 ---
 
-# CollectionTTL object API reference
+import { SdkExampleTabs } from "@site/src/components/SdkExampleTabs";
+// This import is necessary even though it looks like it's un-used; The inject-example-code-snippet
+// plugin will transform instances of SdkExampleTabs to SdkExampleTabsImpl
+import { SdkExampleTabsImpl } from "@site/src/components/SdkExampleTabsImpl";
 
-このオブジェクトは、API メソッドに渡され、TTL を更新するかどうか、そして更新する場合は新しい TTL 値を何にするかを指定します。
+# CollectionTTL オブジェクト API リファレンス
 
-さまざまな状況に対応するために、名前付きのコンストラクタとコピーを提供することで、プロセスをより直感的に試せます。
+CollectionTtl型は、コレクションに対して書き込み操作を行うときに使用します。
 
-Momento Cache における TTL の仕組みについての詳細情報は、[TTL を使用したデータの有効期限切れ](./../../learn/how-it-works/expire-data-with-ttl.md)を参照してください。こちらのドキュメントでは、Momento Cache において TTL がデータの有効期限管理にどのように機能するかについて詳しく説明されています。
+コレクションを更新するときに、TTLを更新したいことがあります。また、TTLをそのままにしたい場合もあります。この場合、パラメータでこの動作を指定できます。
 
-## Compatible data types
+デフォルトの動作は、書き込み操作が発生するたびにコレクションのTTLが変更されます。
 
-CollectionTTLオブジェクトは、**書き込み操作を行う際**、以下のデータ型と互換性があります：
+Momento CacheでのTTLの動作については、[Expire Data with TTL](./../../learn/how-it-works/expire-data-with-ttl.md) を参照してください。
 
-* [Dictionary](./dictionary-collections.md)
-* [List](./list-collections.md)
-* [Set](./set-collections.md)
-* [Sorted Set](./sorted-set-collections.md)
+## 互換性のあるデータ型
+
+CollectionTTLオブジェクトは、以下のデータ型と互換性があります：
+
+* [Dictionary](../api-reference/dictionary-collections.md)
+* [List](../api-reference/list-collections.md)
+* [Set](../api-reference/set-collections.md)
+* [Sorted Set](../api-reference/sorted-set-collections.md)
 
 :::info
 
-`dictionaryFetch` や `listLength` のような読み取り操作を行う際には、CollectionTTL オブジェクトを指定することはできません。
+`dictionaryFetch` や `listLength` のような読み取り操作を行う際には、CollectionTTL オブジェクトを指定することはできない。
 
 :::
 
-## Common method behaviors
+## デフォルトの動作
+
+- コレクションへの書き込み操作では、 `CollectionTtl` パラメータは省略可能です。
+- コレクションTTLが指定されない場合、デフォルトの `CollectionTtl.fromCacheTtl()` が使用される。この値はキャッシュクライアントで設定されているデフォルトのTTLです。
+- コレクションのTTLは、コレクションが変更されるたびに更新されます。
+
+## 例
+
+デフォルト以外の動作が必要な場合は、コレクションの書き込み操作にCollectionTtlオブジェクトを指定できます。
+
+書き込み操作時にコレクションをリフレッシュするTTLを明示的に指定するには、 `CollectionTtl.of()` を使用します：
+
+<SdkExampleTabs snippetId={'API_CollectionTtlOf'} />
+
+これは、コンストラクタを直接呼び出すのと同等の便利なメソッドです。:
+
+<SdkExampleTabs snippetId={'API_CollectionTtlNew'} />
+
+コレクションが作成されたときだけTTLを設定し、それ以降の書き込みではリフレッシュしないようにしたい場合は、`withNoRefreshTtlOnUpdates()`を使用します：
+
+<SdkExampleTabs snippetId={'API_CollectionTtlOfNoRefresh'} />
 
-- もしも関数呼び出し時に CollectionTTL が指定されていない場合、デフォルト値として `CollectionTtl.fromCacheTtl()` が使用されます。この値はキャッシュクライアントに設定された TTL です。
+これもまた、コンストラクターを直接呼び出すのと同等の便利なメソッドです。：
 
-- コレクションが変更されるたびに、コレクションの TTL は更新されます。
+<SdkExampleTabs snippetId={'API_CollectionTtlNewNoRefresh'} />
 
-## Constructor parameters
+## コンストラクタのパラメータ
 
-- ttl: duration - (optional)
-    * もし TTL が指定されていない場合、現在のクライアントに接続されているオブジェクトで設定されている TTL が使用されます。
-- refreshTtl: boolean = true
-    * もし true に設定されている場合、コレクションの TTL は提供された値にリセットされます。
-    * もし false に設定されている場合、アイテムに設定されている既存の TTL は維持されます。
+- ttl: 期間 - (オプション)
+    * TTL が与えられない場合、現在のクライアント接続オブジェクトに設定されている TTL が使用されます。
+- refreshTtl: boolean = true。
+    * trueに設定された場合、コレクションのTTLは指定された値にリセットされます。
+    * falseに設定された場合、アイテムに設定された既存のTTLが保持されます。
 
-## Additional constructors
+## 追加のコンストラクタ
 
-- fromCacheTtl(): CollectionTtl - クライアントの TTL を使用し、`CollectionTtl(null, true)` と同等の動作をします。
-- of(ttl: duration): CollectionTtl - `CollectionTtl(ttl, true)` と同等の動作をします。
-- refreshTtlIfProvided(ttl?: duration): CollectionTtl - もし値が指定されている場合、アイテムの TTL を更新します。値が指定されていない場合、TTL は更新されません。
+- fromCacheTtl() を使用します： CollectionTtl - クライアントの TTL を使用します。
+- of(ttl: duration)： CollectionTtl - `CollectionTtl(ttl, true)`と同じです。
+- refreshTtlIfProvided(ttl?: duration)： CollectionTtl - 値が提供された場合、アイテムのTTLを更新する。値が提供されない場合、TTLはリフレッシュされません。
 
-## Instance methods
+## インスタンスメソッド
 
-- ttlSeconds(): duration - TTL を秒単位で返します。
-- ttlMilliseconds(): duration - TTL をミリ秒単位で返します。
-- refreshTtl(): boolean - アイテムが変更された場合に TTL を更新するかどうかを設定します。
-- withRefreshTtlOnUpdates(): CollectionTtl - コピーを作成しますが、リフレッシュは true です。
-- withNoRefreshTtlOnUpdates(): CollectionTtl - コピーを作成しますが、リフレッシュは false です。
-- toString(): TTL を秒単位で表示し、refreshTtl の設定を表示します。
+- ttlSeconds(): 期間 - TTL を秒単位で返します、
+- ttlMilliseconds(): 持続時間 - TTL をミリ秒で返します。
+- refreshTtl(): boolean - アイテムが変更されたときに TTL を更新するかどうかを設定します。
+- withRefreshTtlOnUpdates()： CollectionTtl - コピーですが、リフレッシュは true です。
+- withNoRefreshTtlOnUpdates()： CollectionTtl - コピーですが、リフレッシュは false です。
+- toString(): TTL (秒) および refreshTtl 設定を表示します。
diff --git a/...ugin-content-docs/current/cache/develop/api-reference/dictionary-collections.md b/...ugin-content-docs/current/cache/develop/api-reference/dictionary-collections.md
@@ -13,6 +13,14 @@ import { SdkExampleTabsImpl } from "@site/src/components/SdkExampleTabsImpl";
 # Momento CacheのDictionary APIリファレンス
 このページでは、Dictionary[コレクションデータ型](./../basics/datatypes.md#dictionary-collections)のMomento APIメソッドについて詳しく説明します。
 
+<img src="/img/dictionary-collections.jpg" width="90%" alt="a technical illustration of stacks of books. some dusty, so not. All collected into groups." />
+
+
+:::info
+
+Momentoコレクションタイプは、[CollectionTTL](./collection-ttl.md)を使用してTTL動作を指定します。これは、すべての "write" 操作のオプション引数です。
+:::
+
 ## Dictionaryのメソッド
 
 ### DictionaryFetch

diff --git a/...rus-plugin-content-docs/current/cache/develop/api-reference/list-collections.md b/...rus-plugin-content-docs/current/cache/develop/api-reference/list-collections.md
@@ -13,6 +13,16 @@ import { SdkExampleTabsImpl } from "@site/src/components/SdkExampleTabsImpl";
 # List API reference for Momento Cache
 このページでは、[リストコレクションデータ型](./../basics/datatypes.md#list-collections)の Momento API メソッドの詳細を説明しています。
 
+<br />
+
+![a technical illustration of a scroll with lists of information. All collected into groups.](@site/static/img/list-collections.jpg)
+
+:::info
+
+Momentoコレクションタイプは、[CollectionTTL](./collection-ttl.md)を使用してTTL動作を指定します。これは、すべての "write" 操作のオプション引数です。
+
+:::
+
 ## List methods
 
 ### ListFetch

diff --git a/...urus-plugin-content-docs/current/cache/develop/api-reference/set-collections.md b/...urus-plugin-content-docs/current/cache/develop/api-reference/set-collections.md
@@ -12,7 +12,13 @@ import { SdkExampleTabsImpl } from "@site/src/components/SdkExampleTabsImpl";
 
 # Momento CacheのためのSet APIについて
 
-![A diagram of luggage as sets, but in any old order and not organized at all.](@site/static/img/sets.jpg)
+![a diagram of luggage as sets, but in any old order and not organized at all.](@site/static/img/sets.jpg)
+
+:::info
+
+Momentoコレクションタイプは、[CollectionTTL](./collection-ttl.md)を使用してTTL動作を指定します。これは、すべての "write" 操作のオプション引数です。
+
+:::
 
 集合は要素の集まりですが、各要素は一度しか現れず、順序は保証されません。
 例: セットが `[1, 2, 3]` を含み、2 を追加してもセットは `[1, 2, 3].` のままです。

diff --git a/...ugin-content-docs/current/cache/develop/api-reference/sorted-set-collections.md b/...ugin-content-docs/current/cache/develop/api-reference/sorted-set-collections.md
@@ -14,6 +14,14 @@ import { SdkExampleTabsImpl } from "@site/src/components/SdkExampleTabsImpl";
 
 Momento Cache におけるソート済みのセットは、値（String, Byte[], など）とスコア（符号付き64ビット浮動小数点数）のペアを持つユニークな要素の集まりです。アイテム内の要素はスコアによって順序付けられています。
 
+![A diagram of luggage as sets, but organized and stacked nicely.](@site/static/img/sorted-sets.jpg)
+
+:::info
+
+Momentoコレクションタイプは、[CollectionTTL](./collection-ttl.md)を使用してTTL動作を指定します。これは、すべての "write" 操作のオプション引数です。
+
+:::
+
 ## Sorted set メソッド
 
 ### SortedSetPutElement