IRPCIndexingDataSource.NotifyObjectSkippedIndexing
Server integration API / specialized internal: not for applications write session
Reports objects or files that an indexer skipped, and why.
| Service | Indexing data source MFiles.IRPCIndexingDataSource |
|---|---|
| gRPC method | /MFiles.IRPCIndexingDataSource/NotifyObjectSkippedIndexing |
| HTTP (mf-http-grpc) | POST /grpc/v1/notify-object-skipped-indexing |
| Request | NotifyObjectSkippedIndexingRequest |
| Response | NotifyObjectSkippedIndexingResponse |
| Book and level | Server integration API, specialized |
| Kind | write |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
For M-Files components only. Search indexers call it. Applications should not call it.
- The skipped-indexing feature behind this method is not enabled in production servers. There the call does nothing and succeeds.
- Otherwise requires the system administrator server role (server right
log_in_to_any_vault).
Request: NotifyObjectSkippedIndexingRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
object_skipped_indexing_state_array[] | repeated ObjectSkippedIndexingState | The object skipped indexing state array. |
object_skipped_indexing_state_array[].object_id | ObjID | The object ID. |
object_skipped_indexing_state_array[].object_id.type | int32 | The object type ID, for example 0 for documents. In a lookup value, the value list ID (for a lookup to objects, the object type ID). |
object_skipped_indexing_state_array[].object_id.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
object_skipped_indexing_state_array[].file_id | FileID | The file ID or zero if not managed file. |
object_skipped_indexing_state_array[].file_id.type | FileIDType | FILE_IDTYPE_SPECIFIC for one file.Values: FILE_IDTYPE_UNINITIALIZED (0), FILE_IDTYPE_ALL (1), FILE_IDTYPE_ANY (2), FILE_IDTYPE_SPECIFIC (3). |
object_skipped_indexing_state_array[].file_id.internal_id | int32 | The file ID. |
object_skipped_indexing_state_array[].file_id.external_repository_id | string | Used only for files in external repositories. Leave empty. |
object_skipped_indexing_state_array[].index_name | IndexName | The index name. |
object_skipped_indexing_state_array[].index_name.configuration_name | string | The name of the index configuration. |
object_skipped_indexing_state_array[].index_name.repository_connection | string | Identifies the external repository connection. |
object_skipped_indexing_state_array[].index_name.configuration_type | IndexConfigurationType | The index configuration type (e.g., Shared versus Legacy).Values: INDEX_CONFIGURATION_TYPE_UNKNOWN (0), INDEX_CONFIGURATION_TYPE_LEGACY (1), INDEX_CONFIGURATION_TYPE_SHARED (2), INDEX_CONFIGURATION_TYPE_ANY (3). |
object_skipped_indexing_state_array[].skip_time | google.protobuf.Timestamp | Time skipped (in UTC). |
object_skipped_indexing_state_array[].reason | ObjectSkippedIndexingReason | Skip reason.Values: OBJECT_SKIPPED_INDEXING_REASON_UNSPECIFIED (0), OBJECT_SKIPPED_INDEXING_REASON_CONFIG_FILE_SIZE (1), OBJECT_SKIPPED_INDEXING_REASON_CONFIG_FILE_EXTENSION (2), OBJECT_SKIPPED_INDEXING_REASON_CONFIG_TIMEOUT_TEXT_EXTRACTION (3), OBJECT_SKIPPED_INDEXING_REASON_ERROR_FILE_NOT_FOUND (4), OBJECT_SKIPPED_INDEXING_REASON_ERROR_FILE_ACCESS_DENIED (5), OBJECT_SKIPPED_INDEXING_REASON_ERROR_FILE_DATA_NOT_AVAILABLE (6), OBJECT_SKIPPED_INDEXING_REASON_ERROR_FILE_IN_USE (7), OBJECT_SKIPPED_INDEXING_REASON_ERROR_FILE_SIZE_MISMATCH (8), OBJECT_SKIPPED_INDEXING_REASON_ERROR_METADATA (9). |
Response: NotifyObjectSkippedIndexingResponse
No fields.