IRPCIndexingDataSource.HasMoreObjectsForIX

View as Markdown

Server integration API / specialized internal: not for applications write session

Checks whether objects are waiting for a combined index, and optionally how many.

ServiceIndexing data source MFiles.IRPCIndexingDataSource
gRPC method/MFiles.IRPCIndexingDataSource/HasMoreObjectsForIX
HTTP (mf-http-grpc)POST /grpc/v1/has-more-objects-for-ix
RequestHasMoreObjectsForIXRequest
ResponseHasMoreObjectsForIXResponse
Book and levelServer integration API, specialized
Kindwrite
SessionRequired: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotentno
Returns metadata structure versionno
Streamingnone (unary)

Remarks

For M-Files components only. Search indexers call it. Applications should not call it.

Request: HasMoreObjectsForIXRequest

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
indexing_requestIndexingRequestGeneral information about the request.
indexing_request.options_obsoleteuint32Control flags for the request.
indexing_request.optionsINDEXINGREQUESTFLAGSControl flags for the request.
indexing_request.options.allboolSpecifies all flags set; Including any future flags.
indexing_request.options.accept_modificationsboolThe indexer accepts new and modified objects in the request.
indexing_request.options.accept_destructionsboolThe indexer accepts destructions of objects in the request.
indexing_request.options.accept_acl_modificationsboolThe indexer accepts ACL modifications of objects in the request.
indexing_request.index_nameIndexNameIdentifies the index.
indexing_request.index_name.configuration_namestringThe name of the index configuration.
indexing_request.index_name.repository_connectionstringIdentifies the external repository connection.
indexing_request.index_name.configuration_typeIndexConfigurationTypeThe 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).
indexing_request.auxiliary_indexer_idstringIf not null, identifies auxiliary indexer that consumes the data.
indexing_request.partitionIndexerPartitionIf set, specifies how to partition the candidate objects for this caller.
indexing_request.partition.ruleIndexerPartitioningRuleSpecifies how the indexing is partitioned.
indexing_request.partition.iduint32Zero-based identifier of the partition.
indexing_request.last_indexed_timestampLogicalTimestampThe last indexed logical timestamp. Ignored if its type is LOGICAL_TIMESTAMP_TYPE_IGNORED.
indexing_request.last_indexed_timestamp.typeLogicalTimestampTypeLogical timestamp type.Values: LOGICAL_TIMESTAMP_TYPE_UNINITIALIZED (0), LOGICAL_TIMESTAMP_TYPE_IGNORED (1), LOGICAL_TIMESTAMP_TYPE_INTEGER (2), LOGICAL_TIMESTAMP_TYPE_STRING (3), LOGICAL_TIMESTAMP_TYPE_INTEGER_AND_STRING (4).
indexing_request.last_indexed_timestamp.dataLogicalTimestampUnionThe data as a union.
indexing_request.last_change_tracking_timestampLogicalTimestampChange Tracking version from last indexed logical timestamp.
indexing_request.last_change_tracking_timestamp.typeLogicalTimestampTypeLogical timestamp type.Values: LOGICAL_TIMESTAMP_TYPE_UNINITIALIZED (0), LOGICAL_TIMESTAMP_TYPE_IGNORED (1), LOGICAL_TIMESTAMP_TYPE_INTEGER (2), LOGICAL_TIMESTAMP_TYPE_STRING (3), LOGICAL_TIMESTAMP_TYPE_INTEGER_AND_STRING (4).
indexing_request.last_change_tracking_timestamp.dataLogicalTimestampUnionThe data as a union.
indexing_request.indexer_locationIndexerLocationDefines if indexer making the request is of type internal (legacy) or external.Values: INDEXER_LOCATION_UNINITIALIZED (0), INDEXER_LOCATION_LEGACY (1), INDEXER_LOCATION_EXTERNAL (2).
last_for_ixObjIDLast indexed object ID. If unset, ignored.
last_for_ix.typeint32The 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).
last_for_ix.item_idItemIDThe ID of the object within its type, in item_id.internal_id.
last_for_ix.item_id.internal_idint32The ID of the object or value list item.
last_for_ix.item_id.external_repository_idExternalRepositoryIDUsed only for objects in external repositories (external connectors). Leave it unset for objects stored in the vault.
thresholduint32If 0, mere existence is checked. Non-zero values trigger the threshold check for available objects.

Response: HasMoreObjectsForIXResponse

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
more_objectsuint320 if no objects wait. If more than threshold objects wait, 4294967295; otherwise the exact number.
last_seen_version_for_ixLogicalTimestampLast seen logical timestamp in case there are no objects to be indexed. Note that logical timestamp may go forward even when there are no matching objects to be indexed.
last_seen_version_for_ix.typeLogicalTimestampTypeLogical timestamp type.Values: LOGICAL_TIMESTAMP_TYPE_UNINITIALIZED (0), LOGICAL_TIMESTAMP_TYPE_IGNORED (1), LOGICAL_TIMESTAMP_TYPE_INTEGER (2), LOGICAL_TIMESTAMP_TYPE_STRING (3), LOGICAL_TIMESTAMP_TYPE_INTEGER_AND_STRING (4).
last_seen_version_for_ix.dataLogicalTimestampUnionThe data as a union.
last_seen_version_for_ix.data.integerLogicalTimestampInteger (oneof data)Logical timestamp as an int64 vector.
last_seen_version_for_ix.data.stringLogicalTimestampString (oneof data)String.
last_seen_version_for_ix.data.integer_and_stringLogicalTimestampIntegerAndString (oneof data)Integer and string.
peidaIndexerDataAvailabilityFlags that tell which kinds of indexer data are available.Values: INDEXER_DATA_AVAILABILITY_UNKNOWN (0), INDEXER_DATA_AVAILABILITY_AVAILABLE (1), INDEXER_DATA_AVAILABILITY_EXHAUSTED (2), INDEXER_DATA_AVAILABILITY_ABORTED (3).