HandlesSystem
Tags
Table of Contents
Properties
Methods
- generateTenantToken() : string
- health() : Health
- isHealthy() : bool
- renameIndex() : Task
- Rename an index instead of swapping it.
- stats() : Stats
- swapIndexes() : Task
- version() : Version
Properties
$health
protected
Health
$health
$stats
protected
Stats
$stats
$tenantToken
protected
TenantToken
$tenantToken
$version
protected
Version
$version
Methods
generateTenantToken()
public
generateTenantToken(string $apiKeyUid, array<string|int, mixed>|object $searchRules[, DateTimeInterface|null} $options = [] ]) : string
Parameters
- $apiKeyUid : string
- $searchRules : array<string|int, mixed>|object
- $options : DateTimeInterface|null} = []
Return values
stringhealth()
public
health() : Health
Return values
HealthisHealthy()
public
isHealthy() : bool
Return values
boolrenameIndex()
Rename an index instead of swapping it.
public
renameIndex(non-empty-string $fromUid, non-empty-string $toUid) : Task
Parameters
- $fromUid : non-empty-string
- $toUid : non-empty-string
Tags
Return values
Taskstats()
public
stats() : Stats
Return values
StatsswapIndexes()
public
swapIndexes(array<int, array{non-empty-string, non-empty-string}> $indexes) : Task
Parameters
- $indexes : array<int, array{non-empty-string, non-empty-string}>
Tags
Return values
Taskversion()
public
version() : Version