この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Partition クラス

Cache.OrgPartition および Cache.SessionPartition の基本クラス。サブクラスを使用して、組織キャッシュとセッションキャッシュのキャッシュパーティションを管理します。

名前空間

Cache

パーティションメソッドのキャッシュキー形式

パーティションオブジェクト (Cache.OrgPartition または Cache.SessionPartition のインスタンス) を取得した後、パーティション内のキャッシュ値を追加、取得、および管理するメソッドがそのキー名を取得します。これらのメソッド (get()put()remove()contains()) にユーザーが指定するキー名には namespace.partition プレフィックスが含まれていません。

Partition のメソッド

Partition のメソッドは次のとおりです。

contains(key)

キャッシュパーティションに指定したキーに対応するキャッシュ値が含まれる場合は true を返します。

署名

public Boolean contains(String key)

パラメーター

key
型: String
キャッシュ値を一意に識別する文字列値 (大文字と小文字を区別)。

戻り値

型: Boolean

キャッシュエントリが見つかった場合は、true。それ以外の場合は、false

createFullyQualifiedKey(namespace, partition, key)

渡された主要コンポーネントから完全修飾キーを生成します。生成されるキー文字列の形式は namespace.partition.key です。

署名

public static String createFullyQualifiedKey(String namespace, String partition, String key)

パラメーター

namespace
型: String
キャッシュキーの名前空間。
partition
型: String
キャッシュキーのパーティション。
key
型: String
キャッシュキーの名前。

戻り値

型: String

createFullyQualifiedPartition(namespace, partition)

渡された名前空間とパーティションから完全修飾パーティション名を生成します。生成されるパーティション文字列の形式は namespace.partition です。

署名

public static String createFullyQualifiedPartition(String namespace, String partition)

パラメーター

namespace
型: String
キャッシュキーの名前空間。
partition
型: String
キャッシュキーのパーティション。

戻り値

型: String

get(key)

キャッシュパーティションから、指定したキーに対応するキャッシュ値を返します。

署名

public Object get(String key)

パラメーター

key
型: String
キャッシュ値を一意に識別する文字列値 (大文字と小文字を区別)。

戻り値

型: Object

キャッシュ値が汎用オブジェクト種別として返されます。戻り値を適切な型にキャストしてください。

get(cacheBuilder, key)

パーティションキャッシュから、指定したキーに対応するキャッシュ値を返します。キャッシュ値が、CacheBuilder インターフェースを実装するクラスの場合、このメソッドを使用します。

署名

public Object get(System.Type cacheBuilder, String key)

パラメーター

cacheBuilder
型: System.Type
CacheBuilder インターフェースを実装する Apex クラス。
key
型: String
cacheBuilder パラメーターに対応するクラス名と組み合せてキャッシュ値を一意に識別する文字列値 (大文字と小文字を区別)。

戻り値

型: Object

キャッシュ値が汎用オブジェクト種別として返されます。戻り値を適切な型にキャストしてください。

getAvgGetSize()

パーティションから取得したすべてのキーの平均項目サイズ (バイト) を返します。

署名

public Long getAvgGetSize()

戻り値

型: Long

getAvgGetTime()

パーティションからのキーの取得に要した平均時間 (ナノ秒) を返します。

署名

public Long getAvgGetTime()

戻り値

型: Long

getAvgValueSize()

廃止済みであり、API バージョン 49.0 以前でのみ使用できます。パーティションのキーの平均項目サイズ (バイト) を返します。

署名

public Long getAvgValueSize()

戻り値

型: Long

getCapacity()

このパーティションの総容量に占めるキャッシュの使用率を返します。

署名

public Double getCapacity()

戻り値

型: Double

パーティションキャッシュの使用率をパーセント値で返します。

getKeys()

キャッシュパーティションに保存され、かつ呼び出し名前空間から参照可能なすべてのキーをまとめて返します。

署名

public Set<String> getKeys()

戻り値

型: Set<String>

すべてのキャッシュキーのセット。

getMaxGetSize()

パーティションから取得したすべてのキーの最大項目サイズ (バイト) を返します。

署名

public Long getMaxGetSize()

戻り値

型: Long

getMaxGetTime()

パーティションからのキーの取得に要した最大時間 (ナノ秒) を返します。

署名

public Long getMaxGetTime()

戻り値

型: Long

getMaxValueSize()

廃止済みであり、API バージョン 49.0 以前でのみ使用できます。パーティションのキーの最大項目サイズ (バイト) を返します。

署名

public Long getMaxValueSize()

戻り値

型: Long

getMissRate()

パーティションのミス率を返します。

署名

public Double getMissRate()

戻り値

型: Double

getName()

このキャッシュパーティションの名前を返します。

署名

public String getName()

戻り値

型: String

このキャッシュパーティションの名前。

getNumKeys()

パーティションのキーの合計数を返します。

署名

public Long getNumKeys()

戻り値

型: Long

isAvailable()

Salesforce セッションが使用できる場合に true を返します。Cache.SessionPartition にのみ適用されます。非同期 Apex や、非同期 Apex でコールされたコードなどで有効なセッションが存在しない場合には、セッションキャッシュを使用できません。たとえば、Apex 一括処理��よって Apex トリガーが実行された場合、このトリガーは非同期コンテキストで実行されるためセッションキャッシュを使用できません。

署名

public Boolean isAvailable()

戻り値

型: Boolean

put(key, value)

特定のキー/値ペアをキャッシュされたエントリとしてキャッシュパーティションに保存します。put メソッドは、組織の名前空間のキャッシュにのみ書き込むことができます。

署名

public void put(String key, Object value)

パラメーター

key
型: String
キャッシュ値を一意に識別する文字列値 (大文字と小文字を区別)。
value
型: Object
キャッシュに保存する値。キャッシュ値はシリアライズ可能にする必要があります。

戻り値

型: void

put(key, value, visibility)

特定のキー/値ペアをキャッシュされたエントリとしてキャッシュパーティションに保存し、キャッシュ値の表示を設定します。

署名

public void put(String key, Object value, cache.Visibility visibility)

パラメーター

key
型: String
キャッシュ値を一意に識別する文字列値 (大文字と小文字を区別)。
value
型: Object
キャッシュに保存する値。キャッシュ値はシリアライズ可能にする必要があります。
visibility
型: Cache.Visibility
キャッシュ値を使用できるのが、同じ名前空間内で実行される Apex コードのみか、任意の名前空間から実行される Apex コードかを示します。

戻り値

型: void

put(key, value, ttlSecs)

特定のキー/値ペアをキャッシュされたエントリとしてキャッシュパーティションに保存し、キャッシュ値の有効期限を設定します。

署名

public void put(String key, Object value, Integer ttlSecs)

パラメーター

key
型: String
キャッシュ値を一意に識別する文字列値 (大文字と小文字を区別)。
value
型: Object
キャッシュに保存する値。キャッシュ値はシリアライズ可能にする必要があります。
ttlSecs
型: Integer
キャッシュ値をキャッシュに保持しておく時間 (秒数)。

戻り値

型: void

put(key, value, ttlSecs, visibility, immutable)

特定のキー/値ペアをキャッシュされたエントリとしてキャッシュパーティションに保存します。このメソッドはまた、キャッシュ値の有効期限、表示、および別の名前空間で上書きされるかどうかを設定します。

署名

public void put(String key, Object value, Integer ttlSecs, cache.Visibility visibility, Boolean immutable)

パラメーター

key
型: String
キャッシュ値を一意に識別する文字列値 (大文字と小文字を区別)。
value
型: Object
キャッシュに保存する値。キャッシュ値はシリアライズ可能にする必要があります。
ttlSecs
型: Integer
キャッシュ値をキャッシュに保持しておく時間 (秒数)。
visibility
型: Cache.Visibility
キャッシュ値を使用できるのが、同じ名前空間内で実行される Apex コードのみか、任意の名前空間から実行される Apex コードかを示します。
immutable
型: Boolean
キャッシュ値を別の名前空間によって上書きできるか (false)、否か (true) を示します。

戻り値

型: void

remove(key)

このキャッシュパーティションから、指定したキーに対応するキャッシュ値を削除します。

署名

public Boolean remove(String key)

パラメーター

key
型: String
キャッシュ値を一意に識別する文字列値 (大文字と小文字を区別)。

戻り値

型: Boolean

キャッシュ値が正常に削除された場合は true。それ以外の場合は、false

remove(cacheBuilder, key)

パーティションキャッシュから、指定したキーに対応するキャッシュ値を削除します。キャッシュ値が、CacheBuilder インターフェースを実装するクラスの場合、このメソッドを使用します。

署名

public Boolean remove(System.Type cacheBuilder, String key)

パラメーター

cacheBuilder
型: System.Type
CacheBuilder インターフェースを実装する Apex クラス。
key
型: String
cacheBuilder パラメーターに対応するクラス名と組み合せてキャッシュ値を一意に識別する文字列値 (大文字と小文字を区別)。

戻り値

型: Boolean

キャッシュ値が正常に削除された場合は true。それ以外の場合は、false

validateCacheBuilder(cacheBuilder)

指定したクラスが CacheBuilder インターフェースを実装していることを確認します。

署名

public static void validateCacheBuilder(System.Type cacheBuilder)

パラメーター

cacheBuilder
型: System.Type
検証するクラス。

戻り値

型: void

validateKey(isDefault, key)

キャッシュキーを検証します。キーが無効の場合は Cache.InvalidParamException が発生します。有効なキーは null でなく、英数字で構成されています。

署名

public static void validateKey(Boolean isDefault, String key)

パラメーター

isDefault
型: Boolean
キーがデフォルトパーティションを参照する場合は、true に設定します。それ以外の場合は、false に設定します。
key
型: String
検証するキー。

戻り値

型: void

validateKeyValue(isDefault, key, value)

キャッシュキーを検証して、キャッシュ値が null 以外であることを確認します。キーまたは値が無効の場合は、Cache.InvalidParamException が発生します。有効なキーは null でなく、英数字で構成されています。

署名

public static void validateKeyValue(Boolean isDefault, String key, Object value)

パラメーター

isDefault
型: Boolean
キーがデフォルトパーティションを参照する場合は、true に設定します。それ以外の場合は、false に設定します。
key
型: String
検証するキー。
value
型: Object
検証する��ャッシュ値。

戻り値

型: void

validateKeys(isDefault, keys)

指定したキャッシュキーを検証します。キーが無効の場合は Cache.InvalidParamException が発生します。有効なキーは null でなく、英数字で構成されています。

署名

public static void validateKeys(Boolean isDefault, Set<String> keys)

パラメーター

isDefault
型: Boolean
キーがデフォルトパーティションを参照する場合は、true に設定します。それ以外の場合は、false に設定します。
keys
型: Set<String>
検証するキー文字列値のセット。

戻り値

型: void

validatePartitionName(name)

パーティション名を検証します (名前が null でないことなど)。

署名

public static void validatePartitionName(String name)

パラメーター

name
型: String
検証するパーティションの名前。

戻り値

型: void