Interfaces, Classes, Traits and Enums
- SearchIndexManagerInterface
Table of Contents
-
$client
: Client
-
__construct()
: mixed
-
allowQuerying()
: mixed
-
analyzeDocument()
: array<string|int, mixed>
-
disallowQuerying()
: mixed
-
dropIndex()
: mixed
-
freezePlan()
: mixed
-
getAllIndexes()
: array<string|int, mixed>
-
getIndex()
: SearchIndex
-
getIndexedDocumentsCount()
: int
-
pauseIngest()
: mixed
-
resumeIngest()
: mixed
-
unfreezePlan()
: mixed
-
upsertIndex()
: mixed
$client
private
Client
$client
__construct()
public
__construct(Client $client) : mixed
Parameters
-
$client
: Client
-
Return values
mixed
—
allowQuerying()
public
allowQuerying(string $indexName[, AllowQueryingSearchIndexOptions|null $options = null ]) : mixed
Parameters
-
$indexName
: string
-
-
$options
: AllowQueryingSearchIndexOptions|null
= null
-
Return values
mixed
—
analyzeDocument()
public
analyzeDocument(string $indexName, mixed $document[, AnalyzeDocumentOptions|null $options = null ]) : array<string|int, mixed>
Parameters
-
$indexName
: string
-
-
$document
: mixed
-
-
$options
: AnalyzeDocumentOptions|null
= null
-
Return values
array<string|int, mixed>
—
disallowQuerying()
public
disallowQuerying(string $indexName[, DisallowQueryingSearchIndexOptions|null $options = null ]) : mixed
Parameters
-
$indexName
: string
-
-
$options
: DisallowQueryingSearchIndexOptions|null
= null
-
Return values
mixed
—
dropIndex()
public
dropIndex(string $name[, DropSearchIndexOptions|null $options = null ]) : mixed
Parameters
-
$name
: string
-
-
$options
: DropSearchIndexOptions|null
= null
-
Return values
mixed
—
freezePlan()
public
freezePlan(string $indexName[, FreezePlanSearchIndexOptions|null $options = null ]) : mixed
Parameters
-
$indexName
: string
-
-
$options
: FreezePlanSearchIndexOptions|null
= null
-
Return values
mixed
—
getAllIndexes()
public
getAllIndexes([GetAllSearchIndexesOptions|null $options = null ]) : array<string|int, mixed>
Parameters
-
$options
: GetAllSearchIndexesOptions|null
= null
-
-
throws
-
InvalidArgumentException
Return values
array<string|int, mixed>
—
getIndex()
public
getIndex(string $indexName[, GetSearchIndexOptions|null $options = null ]) : SearchIndex
Parameters
-
$indexName
: string
-
-
$options
: GetSearchIndexOptions|null
= null
-
-
throws
-
InvalidArgumentException
Return values
SearchIndex
—
getIndexedDocumentsCount()
public
getIndexedDocumentsCount(string $indexName[, GetIndexedSearchIndexOptions|null $options = null ]) : int
Parameters
-
$indexName
: string
-
-
$options
: GetIndexedSearchIndexOptions|null
= null
-
Return values
int
—
pauseIngest()
public
pauseIngest(string $indexName[, PauseIngestSearchIndexOptions|null $options = null ]) : mixed
Parameters
-
$indexName
: string
-
-
$options
: PauseIngestSearchIndexOptions|null
= null
-
Return values
mixed
—
resumeIngest()
public
resumeIngest(string $indexName[, ResumeIngestSearchIndexOptions|null $options = null ]) : mixed
Parameters
-
$indexName
: string
-
-
$options
: ResumeIngestSearchIndexOptions|null
= null
-
Return values
mixed
—
unfreezePlan()
public
unfreezePlan(string $indexName[, UnfreezePlanSearchIndexOptions|null $options = null ]) : mixed
Parameters
-
$indexName
: string
-
-
$options
: UnfreezePlanSearchIndexOptions|null
= null
-
Return values
mixed
—
upsertIndex()
public
upsertIndex(SearchIndex $indexDefinition[, UpsertSearchIndexOptions|null $options = null ]) : mixed
Parameters
-
$indexDefinition
: SearchIndex
-
-
$options
: UpsertSearchIndexOptions|null
= null
-
Return values
mixed
—