Client
in package
uses
HandlesChatWorkspaces, HandlesDumps, HandlesIndex, HandlesTasks, HandlesKeys, HandlesSnapshots, HandlesSystem, HandlesMultiSearch, HandlesBatches, HandlesNetwork
Table of Contents
Properties
- $batches : Batches
- $dumps : Dumps
- $health : Health
- $http : Http
- $index : Indexes
- $keys : Keys
- $network : Network
- $snapshots : Snapshots
- $stats : Stats
- $tasks : Tasks
- $tenantToken : TenantToken
- $version : Version
- $chats : ChatWorkspaces
Methods
- __construct() : mixed
- cancelTasks() : Task
- chatWorkspace() : ChatWorkspaces
- Get a specific chat workspace instance.
- createDump() : Task
- createIndex() : Task
- createKey() : Keys
- createSnapshot() : Task
- deleteIndex() : Task
- deleteKey() : array<string|int, mixed>
- deleteTasks() : Task
- generateTenantToken() : string
- getBatch() : array<string|int, mixed>
- getBatches() : BatchesResults
- getChatWorkspaces() : ChatWorkspacesResults
- List all chat workspaces.
- getIndex() : Indexes
- getIndexes() : IndexesResults
- getKey() : Keys
- getKeys() : KeysResults
- getNetwork() : NetworkResults
- getRawIndex() : array<string|int, mixed>
- getRawKeys() : array<string|int, mixed>
- getTask() : Task
- getTasks() : TasksResults
- health() : array<string|int, mixed>|null
- index() : Indexes
- isHealthy() : bool
- multiSearch() : mixed
- stats() : Stats
- swapIndexes() : Task
- updateIndex() : Task
- updateKey() : Keys
- updateNetwork() : NetworkResults
- version() : Version
Properties
$batches
protected
Batches
$batches
$dumps
protected
Dumps
$dumps
$health
protected
Health
$health
$http
protected
Http
$http
$index
protected
Indexes
$index
$keys
protected
Keys
$keys
$network
protected
Network
$network
$snapshots
protected
Snapshots
$snapshots
$stats
protected
Stats
$stats
$tasks
protected
Tasks
$tasks
$tenantToken
protected
TenantToken
$tenantToken
$version
protected
Version
$version
$chats
private
ChatWorkspaces
$chats
Methods
__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 ]) : Task
Parameters
- $options : CancelTasksQuery|null = null
Return values
TaskchatWorkspace()
Get a specific chat workspace instance.
public
chatWorkspace(string $workspaceName) : ChatWorkspaces
Parameters
- $workspaceName : string
Return values
ChatWorkspacescreateDump()
public
createDump() : Task
Return values
TaskcreateIndex()
public
createIndex(non-empty-string $uid[, array<string|int, mixed> $options = [] ]) : Task
Parameters
- $uid : non-empty-string
- $options : array<string|int, mixed> = []
Return values
TaskcreateKey()
public
createKey([array<string|int, mixed> $options = [] ]) : Keys
Parameters
- $options : array<string|int, mixed> = []
Return values
KeyscreateSnapshot()
public
createSnapshot() : Task
Return values
TaskdeleteIndex()
public
deleteIndex(non-empty-string $uid) : Task
Parameters
- $uid : non-empty-string
Return values
TaskdeleteKey()
public
deleteKey(string $keyOrUid) : array<string|int, mixed>
Parameters
- $keyOrUid : string
Return values
array<string|int, mixed>deleteTasks()
public
deleteTasks([DeleteTasksQuery|null $options = null ]) : Task
Parameters
- $options : DeleteTasksQuery|null = null
Return values
TaskgenerateTenantToken()
public
generateTenantToken(string $apiKeyUid, mixed $searchRules[, array<string|int, mixed> $options = [] ]) : string
Parameters
- $apiKeyUid : string
- $searchRules : mixed
- $options : array<string|int, mixed> = []
Return values
stringgetBatch()
public
getBatch(int $uid) : array<string|int, mixed>
Parameters
- $uid : int
Return values
array<string|int, mixed>getBatches()
public
getBatches([BatchesQuery|null $options = null ]) : BatchesResults
Parameters
- $options : BatchesQuery|null = null
Return values
BatchesResultsgetChatWorkspaces()
List all chat workspaces.
public
getChatWorkspaces() : ChatWorkspacesResults
Return values
ChatWorkspacesResultsgetIndex()
public
getIndex(non-empty-string $uid) : Indexes
Parameters
- $uid : non-empty-string
Return values
IndexesgetIndexes()
public
getIndexes([IndexesQuery|null $options = null ]) : IndexesResults
Parameters
- $options : IndexesQuery|null = null
Return values
IndexesResultsgetKey()
public
getKey(mixed $keyOrUid) : Keys
Parameters
- $keyOrUid : mixed
Return values
KeysgetKeys()
public
getKeys([KeysQuery|null $options = null ]) : KeysResults
Parameters
- $options : KeysQuery|null = null
Return values
KeysResultsgetNetwork()
public
getNetwork() : NetworkResults
Return values
NetworkResultsgetRawIndex()
public
getRawIndex(non-empty-string $uid) : array<string|int, mixed>
Parameters
- $uid : non-empty-string
Return values
array<string|int, mixed>getRawKeys()
public
getRawKeys() : array<string|int, mixed>
Return values
array<string|int, mixed>getTask()
public
getTask(int $uid) : Task
Parameters
- $uid : int
Return values
TaskgetTasks()
public
getTasks([TasksQuery|null $options = null ]) : TasksResults
Parameters
- $options : TasksQuery|null = null
Return values
TasksResultshealth()
public
health() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullindex()
public
index(non-empty-string $uid) : Indexes
Parameters
- $uid : non-empty-string
Return values
IndexesisHealthy()
public
isHealthy() : bool
Return values
boolmultiSearch()
public
multiSearch([array<int, SearchQuery> $queries = [] ][, MultiSearchFederation|null $federation = null ]) : mixed
Parameters
- $queries : array<int, SearchQuery> = []
- $federation : MultiSearchFederation|null = null
stats()
public
stats() : Stats
Return values
StatsswapIndexes()
public
swapIndexes(array<string|int, mixed> $indexes) : Task
Parameters
- $indexes : array<string|int, mixed>
Return values
TaskupdateIndex()
public
updateIndex(non-empty-string $uid[, array<string|int, mixed> $options = [] ]) : Task
Parameters
- $uid : non-empty-string
- $options : array<string|int, mixed> = []
Return values
TaskupdateKey()
public
updateKey(string $keyOrUid[, array<string|int, mixed> $options = [] ]) : Keys
Parameters
- $keyOrUid : string
- $options : array<string|int, mixed> = []
Return values
KeysupdateNetwork()
public
updateNetwork(RemoteConfig>} $network) : NetworkResults
Parameters
- $network : RemoteConfig>}
Return values
NetworkResultsversion()
public
version() : Version