package protocol.sdk.search.index_manager

Get desktop application:
View/edit binary Protocol Buffers messages

Returns void (e.g. Result.success).

Used in: Command

• string index_name = 1

• optional AllowQueryingSearchIndexOptions options = 2

Used in: AllowQuerying

• optional int32 timeout_msecs = 1

• optional string parent_span_id = 2

Returns Result.analyze_document;

Used in: Command

• string index_name = 1

• bytes document = 2

• optional AnalyzeDocumentOptions options = 3

Used in: AnalyzeDocument

• optional int32 timeout_msecs = 1

• optional string parent_span_id = 2

Used in: Result

• repeated bytes results = 1

These commands are shared between SearchIndexManager and ScopeSearchIndexManager. If API calls are added to just one of those, they should not go here. Add them in scope.search.index_manager.Command or cluster.search.index_manager.Command instead.

Used in: cluster.search.index_manager.Command, scope.search.index_manager.Command

• oneof command

  • GetIndex get_index = 1

  • GetAllIndexes get_all_indexes = 2

  • UpsertIndex upsert_index = 3

  • DropIndex drop_index = 4

  • GetIndexedDocumentsCount get_indexed_documents_count = 5

  • PauseIngest pause_ingest = 6

  • ResumeIngest resume_ingest = 7

  • AllowQuerying allow_querying = 8

  • DisallowQuerying disallow_querying = 9

  • FreezePlan freeze_plan = 10

  • UnfreezePlan unfreeze_plan = 11

  • AnalyzeDocument analyze_document = 12

Returns void (e.g. Result.success).

Used in: Command

• string index_name = 1

• optional DisallowQueryingSearchIndexOptions options = 2

Used in: DisallowQuerying

• optional int32 timeout_msecs = 1

• optional string parent_span_id = 2

Returns void (e.g. Result.success).

Used in: Command

• string index_name = 1

• optional DropSearchIndexOptions options = 2

Used in: DropIndex

• optional int32 timeout_msecs = 1

• optional string parent_span_id = 2

Returns void (e.g. Result.success).

Used in: Command

• string index_name = 1

• optional FreezePlanSearchIndexOptions options = 2

Used in: FreezePlan

• optional int32 timeout_msecs = 1

• optional string parent_span_id = 2

Returns Result.indexes.

Used in: Command

• optional GetAllSearchIndexesOptions options = 1

Used in: GetAllIndexes

• optional int32 timeout_msecs = 1

• optional string parent_span_id = 2

Returns Result.index.

Used in: Command

• string index_name = 1

• optional GetSearchIndexOptions options = 2

Returns Result.indexed_document_counts.

Used in: Command

• string index_name = 1

• optional GetIndexedSearchIndexOptions options = 2

Used in: GetIndexedDocumentsCount

• optional int32 timeout_msecs = 1

• optional string parent_span_id = 2

Used in: GetIndex

• optional int32 timeout_msecs = 1

• optional string parent_span_id = 2

Returns void (e.g. Result.success).

Used in: Command

• string index_name = 1

• optional PauseIngestSearchIndexOptions options = 2

Used in: PauseIngest

• optional int32 timeout_msecs = 1

• optional string parent_span_id = 2

Used in: Result

• oneof result

  • bool success = 1

    Used for void results.

  • SearchIndex index = 2

  • SearchIndexes indexes = 3

  • int32 indexed_document_counts = 4

  • AnalyzeDocumentResult analyze_document = 5

Returns void (e.g. Result.success).

Used in: Command

• string index_name = 1

• optional ResumeIngestSearchIndexOptions options = 2

Used in: ResumeIngest

• optional int32 timeout_msecs = 1

• optional string parent_span_id = 2

Used in: Result, SearchIndexes

• string uuid = 1

• string name = 2

• string type = 3

• string source_uuid = 5

• string source_type = 7

• bytes params = 4

  It's left intentionally ambiguous in the SDK-RFC how to represent these in the SDK. For FIT, they should be converted into JSON.

• bytes source_params = 6

• bytes plan_params = 8

Used in: Result

• repeated SearchIndex indexes = 1

Returns void (e.g. Result.success).

Used in: Command

• string index_name = 1

• optional UnfreezePlanSearchIndexOptions options = 2

Used in: UnfreezePlan

• optional int32 timeout_msecs = 1

• optional string parent_span_id = 2

Returns void (e.g. Result.success).

Used in: Command

• bytes index_definition = 1

  A JSON blob that the performer should use to create a SearchIndex.

• optional UpsertSearchIndexOptions options = 2

Used in: UpsertIndex

• optional int32 timeout_msecs = 1

• optional string parent_span_id = 2