Documentation

SearchAdminServiceClient extends BaseStub
in package

Table of Contents

__construct()  : mixed
AllowIndexQuerying()  : UnaryCall
AnalyzeDocument()  : UnaryCall
CreateIndex()  : UnaryCall
DeleteIndex()  : UnaryCall
DisallowIndexQuerying()  : UnaryCall
FreezeIndexPlan()  : UnaryCall
GetIndex()  : UnaryCall
GetIndexedDocumentsCount()  : UnaryCall
ListIndexes()  : UnaryCall
PauseIndexIngest()  : UnaryCall
ResumeIndexIngest()  : UnaryCall
UnfreezeIndexPlan()  : UnaryCall
UpdateIndex()  : UnaryCall

Methods

__construct()

public __construct(string $hostname, array<string|int, mixed> $opts[, Channel $channel = null ]) : mixed
Parameters
$hostname : string

hostname

$opts : array<string|int, mixed>

channel options

$channel : Channel = null

(optional) re-use channel object

Return values
mixed

AllowIndexQuerying()

public AllowIndexQuerying(AllowIndexQueryingRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall
Parameters
$argument : AllowIndexQueryingRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

AnalyzeDocument()

public AnalyzeDocument(AnalyzeDocumentRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall
Parameters
$argument : AnalyzeDocumentRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

CreateIndex()

public CreateIndex(CreateIndexRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall
Parameters
$argument : CreateIndexRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

DeleteIndex()

public DeleteIndex(DeleteIndexRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall
Parameters
$argument : DeleteIndexRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

DisallowIndexQuerying()

public DisallowIndexQuerying(DisallowIndexQueryingRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall
Parameters
$argument : DisallowIndexQueryingRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

FreezeIndexPlan()

public FreezeIndexPlan(FreezeIndexPlanRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall
Parameters
$argument : FreezeIndexPlanRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

GetIndex()

public GetIndex(GetIndexRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall
Parameters
$argument : GetIndexRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

ListIndexes()

public ListIndexes(ListIndexesRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall
Parameters
$argument : ListIndexesRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

PauseIndexIngest()

public PauseIndexIngest(PauseIndexIngestRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall
Parameters
$argument : PauseIndexIngestRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

ResumeIndexIngest()

public ResumeIndexIngest(ResumeIndexIngestRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall
Parameters
$argument : ResumeIndexIngestRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

UnfreezeIndexPlan()

public UnfreezeIndexPlan(UnfreezeIndexPlanRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall
Parameters
$argument : UnfreezeIndexPlanRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

UpdateIndex()

public UpdateIndex(UpdateIndexRequest $argument[, array<string|int, mixed> $metadata = [] ][, array<string|int, mixed> $options = [] ]) : UnaryCall
Parameters
$argument : UpdateIndexRequest

input argument

$metadata : array<string|int, mixed> = []

metadata

$options : array<string|int, mixed> = []

call options

Return values
UnaryCall

        

Search results