Table of Contents
Properties
-
$dumps
: Dumps
-
$health
: Health
-
$http
: Http
-
$index
: Indexes
-
$keys
: Keys
-
$snapshots
: Snapshots
-
$stats
: Stats
-
$tasks
: Tasks
-
$tenantToken
: TenantToken
-
$version
: Version
Methods
-
__construct()
: mixed
-
cancelTasks()
: array<string|int, mixed>
-
createDump()
: array<string|int, mixed>
-
createIndex()
: array<string|int, mixed>
-
createKey()
: Keys
-
createSnapshot()
: array<string|int, mixed>
-
deleteIndex()
: array<string|int, mixed>
-
deleteKey()
: array<string|int, mixed>
-
deleteTasks()
: array<string|int, mixed>
-
generateTenantToken()
: string
-
getIndex()
: Indexes
-
getIndexes()
: IndexesResults
-
getKey()
: Keys
-
getKeys()
: KeysResults
-
getRawIndex()
: array<string|int, mixed>
-
getRawKeys()
: array<string|int, mixed>
-
getTask()
: array<string|int, mixed>
-
getTasks()
: TasksResults
-
health()
: array<string|int, mixed>|null
-
index()
: Indexes
-
isHealthy()
: bool
-
multiSearch()
: mixed
-
stats()
: array<string|int, mixed>
-
swapIndexes()
: array<string|int, mixed>
-
updateIndex()
: array<string|int, mixed>
-
updateKey()
: Keys
-
version()
: array<string|int, mixed>
-
waitForTask()
: array<string|int, mixed>
-
waitForTasks()
: array<string|int, mixed>
$dumps
protected
Dumps
$dumps
$health
protected
Health
$health
$http
protected
Http
$http
$index
protected
Indexes
$index
$keys
protected
Keys
$keys
$snapshots
protected
Snapshots
$snapshots
$stats
protected
Stats
$stats
$tasks
protected
Tasks
$tasks
$tenantToken
protected
TenantToken
$tenantToken
$version
protected
Version
$version
__construct()
public
__construct(string $url[, string|null $apiKey = null ][, ClientInterface|null $httpClient = null ][, RequestFactoryInterface|null $requestFactory = null ][, array<int, string> $clientAgents = [] ][, StreamFactoryInterface|null $streamFactory = null ]) : mixed
Parameters
-
$url
: string
-
-
$apiKey
: string|null
= null
-
-
$httpClient
: ClientInterface|null
= null
-
-
$requestFactory
: RequestFactoryInterface|null
= null
-
-
$clientAgents
: array<int, string>
= []
-
-
$streamFactory
: StreamFactoryInterface|null
= null
-
cancelTasks()
public
cancelTasks([CancelTasksQuery|null $options = null ]) : array<string|int, mixed>
Parameters
-
$options
: CancelTasksQuery|null
= null
-
Return values
array<string|int, mixed>
createDump()
public
createDump() : array<string|int, mixed>
Return values
array<string|int, mixed>
createIndex()
public
createIndex(string $uid[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
-
$uid
: string
-
-
$options
: array<string|int, mixed>
= []
-
Return values
array<string|int, mixed>
createKey()
public
createKey([array<string|int, mixed> $options = [] ]) : Keys
Parameters
-
$options
: array<string|int, mixed>
= []
-
createSnapshot()
public
createSnapshot() : array<string|int, mixed>
Return values
array<string|int, mixed>
deleteIndex()
public
deleteIndex(string $uid) : array<string|int, mixed>
Parameters
-
$uid
: string
-
Return values
array<string|int, mixed>
deleteKey()
public
deleteKey(string $keyOrUid) : array<string|int, mixed>
Parameters
-
$keyOrUid
: string
-
Return values
array<string|int, mixed>
deleteTasks()
public
deleteTasks([DeleteTasksQuery|null $options = null ]) : array<string|int, mixed>
Parameters
-
$options
: DeleteTasksQuery|null
= null
-
Return values
array<string|int, mixed>
generateTenantToken()
public
generateTenantToken(string $apiKeyUid, mixed $searchRules[, array<string|int, mixed> $options = [] ]) : string
Parameters
-
$apiKeyUid
: string
-
-
$searchRules
: mixed
-
-
$options
: array<string|int, mixed>
= []
-
getIndex()
public
getIndex(string $uid) : Indexes
Parameters
-
$uid
: string
-
getIndexes()
public
getIndexes([IndexesQuery|null $options = null ]) : IndexesResults
Parameters
-
$options
: IndexesQuery|null
= null
-
getKey()
public
getKey(mixed $keyOrUid) : Keys
Parameters
-
$keyOrUid
: mixed
-
getKeys()
public
getKeys([KeysQuery|null $options = null ]) : KeysResults
Parameters
-
$options
: KeysQuery|null
= null
-
getRawIndex()
public
getRawIndex(string $uid) : array<string|int, mixed>
Parameters
-
$uid
: string
-
Return values
array<string|int, mixed>
getRawKeys()
public
getRawKeys() : array<string|int, mixed>
Return values
array<string|int, mixed>
getTask()
public
getTask(mixed $uid) : array<string|int, mixed>
Parameters
-
$uid
: mixed
-
Return values
array<string|int, mixed>
getTasks()
public
getTasks([TasksQuery|null $options = null ]) : TasksResults
Parameters
-
$options
: TasksQuery|null
= null
-
health()
public
health() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null
index()
public
index(string $uid) : Indexes
Parameters
-
$uid
: string
-
isHealthy()
public
isHealthy() : bool
multiSearch()
public
multiSearch([array<int, SearchQuery> $queries = [] ]) : mixed
Parameters
-
$queries
: array<int, SearchQuery>
= []
-
stats()
public
stats() : array<string|int, mixed>
Return values
array<string|int, mixed>
swapIndexes()
public
swapIndexes(array<string|int, mixed> $indexes) : array<string|int, mixed>
Parameters
-
$indexes
: array<string|int, mixed>
-
Return values
array<string|int, mixed>
updateIndex()
public
updateIndex(string $uid[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
-
$uid
: string
-
-
$options
: array<string|int, mixed>
= []
-
Return values
array<string|int, mixed>
updateKey()
public
updateKey(string $keyOrUid[, array<string|int, mixed> $options = [] ]) : Keys
Parameters
-
$keyOrUid
: string
-
-
$options
: array<string|int, mixed>
= []
-
version()
public
version() : array<string|int, mixed>
Return values
array<string|int, mixed>
waitForTask()
public
waitForTask(mixed $uid[, int $timeoutInMs = 5000 ][, int $intervalInMs = 50 ]) : array<string|int, mixed>
Parameters
-
$uid
: mixed
-
-
$timeoutInMs
: int
= 5000
-
-
$intervalInMs
: int
= 50
-
-
throws
-
TimeOutException
Return values
array<string|int, mixed>
waitForTasks()
public
waitForTasks(mixed $uids[, int $timeoutInMs = 5000 ][, int $intervalInMs = 50 ]) : array<string|int, mixed>
Parameters
-
$uids
: mixed
-
-
$timeoutInMs
: int
= 5000
-
-
$intervalInMs
: int
= 50
-
-
throws
-
TimeOutException
Return values
array<string|int, mixed>