SearchIndexManagementRequestConverter
Table of Contents
-
getAllowQueryingRequest()
: AllowIndexQueryingRequest
-
getAnalyzeDocumentRequest()
: AnalyzeDocumentRequest
-
getCreateIndexRequest()
: CreateIndexRequest
-
getDisallowQueryingRequest()
: DisallowIndexQueryingRequest
-
getDropIndexRequest()
: DeleteIndexRequest
-
getFreezePlanRequest()
: FreezeIndexPlanRequest
-
getGetAllIndexesRequest()
: ListIndexesRequest
-
getGetIndexedDocumentCountRequest()
: GetIndexedDocumentsCountRequest
-
getGetIndexRequest()
: GetIndexRequest
-
getPauseIngestRequest()
: PauseIndexIngestRequest
-
getResumeIngestRequest()
: ResumeIndexIngestRequest
-
getUnfreezePlanRequest()
: UnfreezeIndexPlanRequest
-
getUpdateIndexRequest()
: UpdateIndexRequest
-
getIndex()
: array<string|int, mixed>
getAllowQueryingRequest()
public
static getAllowQueryingRequest(string $indexName[, string|null $bucketName = null ][, string|null $scopeName = null ]) : AllowIndexQueryingRequest
Parameters
-
$indexName
: string
-
-
$bucketName
: string|null
= null
-
-
$scopeName
: string|null
= null
-
Return values
AllowIndexQueryingRequest
—
getAnalyzeDocumentRequest()
public
static getAnalyzeDocumentRequest(string $indexName, mixed $document[, string|null $bucketName = null ][, string|null $scopeName = null ]) : AnalyzeDocumentRequest
Parameters
-
$indexName
: string
-
-
$document
: mixed
-
-
$bucketName
: string|null
= null
-
-
$scopeName
: string|null
= null
-
Return values
AnalyzeDocumentRequest
—
getCreateIndexRequest()
public
static getCreateIndexRequest(array<string|int, mixed> $index[, string|null $bucketName = null ][, string|null $scopeName = null ]) : CreateIndexRequest
Parameters
-
$index
: array<string|int, mixed>
-
-
$bucketName
: string|null
= null
-
-
$scopeName
: string|null
= null
-
Return values
CreateIndexRequest
—
getDisallowQueryingRequest()
public
static getDisallowQueryingRequest(string $indexName[, string|null $bucketName = null ][, string|null $scopeName = null ]) : DisallowIndexQueryingRequest
Parameters
-
$indexName
: string
-
-
$bucketName
: string|null
= null
-
-
$scopeName
: string|null
= null
-
Return values
DisallowIndexQueryingRequest
—
getDropIndexRequest()
public
static getDropIndexRequest(string $indexName[, string|null $bucketName = null ][, string|null $scopeName = null ]) : DeleteIndexRequest
Parameters
-
$indexName
: string
-
-
$bucketName
: string|null
= null
-
-
$scopeName
: string|null
= null
-
Return values
DeleteIndexRequest
—
getFreezePlanRequest()
public
static getFreezePlanRequest(string $indexName[, string|null $bucketName = null ][, string|null $scopeName = null ]) : FreezeIndexPlanRequest
Parameters
-
$indexName
: string
-
-
$bucketName
: string|null
= null
-
-
$scopeName
: string|null
= null
-
Return values
FreezeIndexPlanRequest
—
getGetAllIndexesRequest()
public
static getGetAllIndexesRequest([string|null $bucketName = null ][, string|null $scopeName = null ]) : ListIndexesRequest
Parameters
-
$bucketName
: string|null
= null
-
-
$scopeName
: string|null
= null
-
Return values
ListIndexesRequest
—
getGetIndexedDocumentCountRequest()
public
static getGetIndexedDocumentCountRequest(string $indexName[, string|null $bucketName = null ][, string|null $scopeName = null ]) : GetIndexedDocumentsCountRequest
Parameters
-
$indexName
: string
-
-
$bucketName
: string|null
= null
-
-
$scopeName
: string|null
= null
-
Return values
GetIndexedDocumentsCountRequest
—
getGetIndexRequest()
public
static getGetIndexRequest(string $indexName[, string|null $bucketName = null ][, string|null $scopeName = null ]) : GetIndexRequest
Parameters
-
$indexName
: string
-
-
$bucketName
: string|null
= null
-
-
$scopeName
: string|null
= null
-
Return values
GetIndexRequest
—
getPauseIngestRequest()
public
static getPauseIngestRequest(string $indexName[, string|null $bucketName = null ][, string|null $scopeName = null ]) : PauseIndexIngestRequest
Parameters
-
$indexName
: string
-
-
$bucketName
: string|null
= null
-
-
$scopeName
: string|null
= null
-
Return values
PauseIndexIngestRequest
—
getResumeIngestRequest()
public
static getResumeIngestRequest(string $indexName[, string|null $bucketName = null ][, string|null $scopeName = null ]) : ResumeIndexIngestRequest
Parameters
-
$indexName
: string
-
-
$bucketName
: string|null
= null
-
-
$scopeName
: string|null
= null
-
Return values
ResumeIndexIngestRequest
—
getUnfreezePlanRequest()
public
static getUnfreezePlanRequest(string $indexName[, string|null $bucketName = null ][, string|null $scopeName = null ]) : UnfreezeIndexPlanRequest
Parameters
-
$indexName
: string
-
-
$bucketName
: string|null
= null
-
-
$scopeName
: string|null
= null
-
Return values
UnfreezeIndexPlanRequest
—
getUpdateIndexRequest()
public
static getUpdateIndexRequest(array<string|int, mixed> $index[, string|null $bucketName = null ][, string|null $scopeName = null ]) : UpdateIndexRequest
Parameters
-
$index
: array<string|int, mixed>
-
-
$bucketName
: string|null
= null
-
-
$scopeName
: string|null
= null
-
Return values
UpdateIndexRequest
—
getIndex()
private
static getIndex(array<string|int, mixed> $indexDefinition) : array<string|int, mixed>
Parameters
-
$indexDefinition
: array<string|int, mixed>
-
Return values
array<string|int, mixed>
—