IRPCIndexingDataSource.CacheFileForIndexingCollective
Server integration API / specialized internal: not for applications write session
Like CacheFileForIndexing, for up to 20 file versions in one call, processed in parallel.
| Service | Indexing data source MFiles.IRPCIndexingDataSource |
|---|---|
| gRPC method | /MFiles.IRPCIndexingDataSource/CacheFileForIndexingCollective |
| HTTP (mf-http-grpc) | POST /grpc/v1/cache-file-for-indexing-collective |
| Request | CacheFileForIndexingCollectiveRequest |
| Response | CacheFileForIndexingCollectiveResponse |
| 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. The M-Files indexing service, which runs on the server computer, calls it. Applications should not call it: the results are paths on the server's own disk.
- Requires a vault session with the vault rights
see_all_objectsandsee_deleted_objects. indexing_elementsmust have 1 to 20 entries.max_threadsabove 20 is reduced to 20.
Request: CacheFileForIndexingCollectiveRequest
A structure that specifies cache file for indexing request.
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 |
|---|---|---|
indexing_elements[] | repeated CacheFileForIndexingElement | The file versions to cache, with an optional subfolder each. |
indexing_elements[].file_information | FileInfoForFIX | File info for indexing. |
indexing_elements[].file_information.obj_file_ver | ObjFileVer | File version. |
indexing_elements[].file_information.is_destroyed | bool | True if the file has been destroyed and is no longer available. If true then only the objfilever member is valid. |
indexing_elements[].file_information.data_file_version | int32 | Data file version if the file is an internal file. |
indexing_elements[].file_information.size | int64 | The logical size of the file in bytes. |
indexing_elements[].file_information.extension | string | The file extension, not including the dot (e.g. "doc"). This unencoded extension may contain characters that are not allowed in file extensions in file systems. |
indexing_elements[].file_information.relevance_score | float | Relevance score of the object. |
indexing_elements[].file_information.file_ids[] | repeated FileID | All file IDs of the object's LCI version. |
indexing_elements[].file_information.timestamp | LogicalTimestamp | Logical timestamp for indexing. |
indexing_elements[].file_information.object_data | ObjectVersionExWP | If not null contains the basic object version information. The search results are returned from the server using this information with external content repositories. |
indexing_elements[].file_information.last_modified_for_indexing | google.protobuf.Timestamp | The last modified timestamp for indexing. |
indexing_elements[].file_information.repository_path | FolderArray | If not null contains the array of folders describing the repository path to the object version location. The search results are returned from the server using this information with external content repositories. |
indexing_elements[].file_format | FileFormat | Specifies the requested file format to cache.Values: FILE_FORMAT_NATIVE (0), FILE_FORMAT_PDF (1), FILE_FORMAT_DISPLAY_ONLY_PDF (2), FILE_FORMAT_PLAIN_TEXT (3), FILE_FORMAT_MARKDOWN (4). |
indexing_elements[].sub_directory | string | The optional subdirectory under Filedata\Temp\FIX. |
max_threads | uint32 | The maximum number of files to cache in parallel, at most 20. |
Response: CacheFileForIndexingCollectiveResponse
A structure that specifies cache file for indexing response.
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 |
|---|---|---|
indexing_elements[] | repeated CacheFileForIndexingCollectiveResponseElement | The cache file for indexing array. |
indexing_elements[].full_path | string | Receives the full path of the cached file. The caller owns the file. |
indexing_elements[].file_format | FileFormat | The actual file format received.Values: FILE_FORMAT_NATIVE (0), FILE_FORMAT_PDF (1), FILE_FORMAT_DISPLAY_ONLY_PDF (2), FILE_FORMAT_PLAIN_TEXT (3), FILE_FORMAT_MARKDOWN (4). |
Related methods
- CacheFileForIndexing -- Writes a file version, in the requested format, to a temporary folder on the server computer and returns its local path.