@terascope/teraslice-state-storage / elasticsearch-state-storage / default
Class: default
Defined in: teraslice-state-storage/src/elasticsearch-state-storage/index.ts:11
Constructors
Constructor
new default(
client,logger,config):ESCachedStateStorage
Defined in: teraslice-state-storage/src/elasticsearch-state-storage/index.ts:23
Parameters
| Parameter | Type |
|---|---|
client | Client |
logger | Logger |
config | ESStateStorageConfig |
Returns
ESCachedStateStorage
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
cache | public | default<DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>> | teraslice-state-storage/src/elasticsearch-state-storage/index.ts:21 |
Methods
count()
count():
number
Defined in: teraslice-state-storage/src/elasticsearch-state-storage/index.ts:42
Returns
number
get()
get(
doc):Promise<undefined|DataEntity<Record<string,any>,_DataEntityMetadata<Record<string,any>>>>
Defined in: teraslice-state-storage/src/elasticsearch-state-storage/index.ts:100
Parameters
| Parameter | Type |
|---|---|
doc | DataEntity |
Returns
Promise<undefined | DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>>
getFromCache()
getFromCache(
doc):undefined|DataEntity<Record<string,any>,_DataEntityMetadata<Record<string,any>>>
Defined in: teraslice-state-storage/src/elasticsearch-state-storage/index.ts:82
Parameters
| Parameter | Type |
|---|---|
doc | DataEntity |
Returns
undefined | DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>
getFromCacheByKey()
getFromCacheByKey(
key):undefined|DataEntity<Record<string,any>,_DataEntityMetadata<Record<string,any>>>
Defined in: teraslice-state-storage/src/elasticsearch-state-storage/index.ts:87
Parameters
| Parameter | Type |
|---|---|
key | string | number |
Returns
undefined | DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>
getIdentifier()
getIdentifier(
doc,metaField):string
Defined in: teraslice-state-storage/src/elasticsearch-state-storage/index.ts:46
Parameters
| Parameter | Type |
|---|---|
doc | DataEntity |
metaField | string |
Returns
string
initialize()
initialize():
Promise<void>
Defined in: teraslice-state-storage/src/elasticsearch-state-storage/index.ts:36
Returns
Promise<void>
isCached()
isCached(
doc):boolean
Defined in: teraslice-state-storage/src/elasticsearch-state-storage/index.ts:91
Parameters
| Parameter | Type |
|---|---|
doc | DataEntity |
Returns
boolean
isKeyCached()
isKeyCached(
key):boolean
Defined in: teraslice-state-storage/src/elasticsearch-state-storage/index.ts:96
Parameters
| Parameter | Type |
|---|---|
key | string | number |
Returns
boolean
mget()
mget(
docArray):Promise<MGetCacheResponse>
Defined in: teraslice-state-storage/src/elasticsearch-state-storage/index.ts:108
Parameters
| Parameter | Type |
|---|---|
docArray | DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>[] |
Returns
Promise<MGetCacheResponse>
mset()
mset(
docArray):Promise<void>
Defined in: teraslice-state-storage/src/elasticsearch-state-storage/index.ts:58
Parameters
| Parameter | Type |
|---|---|
docArray | DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>[] |
Returns
Promise<void>
set()
set(
doc):void
Defined in: teraslice-state-storage/src/elasticsearch-state-storage/index.ts:72
Parameters
| Parameter | Type |
|---|---|
doc | DataEntity |
Returns
void
setCacheByKey()
setCacheByKey(
key,doc):void
Defined in: teraslice-state-storage/src/elasticsearch-state-storage/index.ts:78
Parameters
| Parameter | Type |
|---|---|
key | string | number |
doc | DataEntity |
Returns
void
shutdown()
shutdown():
Promise<void>
Defined in: teraslice-state-storage/src/elasticsearch-state-storage/index.ts:38
Returns
Promise<void>