A search index object provides relevant information for a dimension's indexing status.
The existence of this object within a dimension indicates that automatic indexing is
enabled and any time a dimension node is created, updated, or deleted, this operation will
trigger an incremental indexing job.
Fields
| indexName
string
|
The system-defined index name that is used to reference the dimension within the external
search engine (e.g. ElasticSearch index name).
This index name is created using the following format: "{tenant-id}-{dimension-id}-{version-id}".
For example, if the index name is "e4e0fa74-bb0c-4c68-825f-20b786077afa_5bf436bc-1a67-4025-8374-1789adc83280_0d2e570a-73be-43ae-a67b-75693924810d"
then the tenant id is "e4e0fa74-bb0c-4c68-825f-20b786077afa", the dimension id is
"5bf436bc-1a67-4025-8374-1789adc83280", and the version-id is "73be-43ae-a67b-75693924810d".
|
| primaryShardCount
long
|
The shard count to be used in the external search engine for this dimension's index.
If this field is not provided, the service will calculate an automatic value based on
the count of dimension nodes within this dimension.
|
| primaryShardCountOverwritten
boolean
|
Whether the primaryShardCount field was overwritten manually by the user. In other words,
if the user provides an explicit value for primaryShardCount then this field will be
marked as true.
|
| lastIndexAt
string
|
Read-only field corresponding to the ISO-8601 UTC date and time of the last node index
operation within this dimension.
|
Example
1
{
"indexName": "e4e0fa74-bb0c-4c68-825f-20b786077afa_5bf436bc-1a67-4025-8374-1789adc83280_0d2e570a-73be-43ae-a67b-75693924810d",
"primaryShardCount": 4,
"primaryShardCountOverwritten": true
"lastIndexAt": "2020-01-01T00:00:01"
}