IRPCMonitoringDatapointsSink.PushDatapointsForIndexingCommon

View as Markdown

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

Stores index-level data points of one index: data format capabilities, index size and the times of the last rebuild.

ServiceMonitoring data points MFiles.IRPCMonitoringDatapointsSink
gRPC method/MFiles.IRPCMonitoringDatapointsSink/PushDatapointsForIndexingCommon
HTTP (mf-http-grpc)POST /grpc/v1/push-datapoints-for-indexing-common
RequestPushDatapointsForIndexingCommonRequest
ResponsePushDatapointsForIndexingCommonResponse
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. The M-Files indexing service calls it. Applications should not call it.

Request: PushDatapointsForIndexingCommonRequest

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

FieldTypeDescription
sourceMonitoringSourceForIndexingThe monitoring data source.
source.indexIndexNameIdentifies the index associated with the monitoring data.
source.index.configuration_namestringThe name of the index configuration.
source.index.repository_connectionstringIdentifies the external repository connection.
source.index.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).
source.auxiliary_indexer_idstringIf set, identifies auxiliary indexer associated with the monitoring data.
source.partitionIndexerPartitionIf set, specifies the partition associated with the monitoring data.
source.partition.ruleIndexerPartitioningRuleSpecifies how the indexing is partitioned.
source.partition.iduint32Zero-based identifier of the partition.
datapointsMonitoringDatapointsForIndexingCommonThe monitoring datapoints.
datapoints.capabilitiesStringValueIf set, specifies the index data format capabilities. unset indicates "not applicable".
datapoints.capabilities.valuestringString.
datapoints.index_size_as_itemsint32If not -1, specifies the index size as item count.
datapoints.index_size_as_megabytesint32If not -1, specifies the index size as megabytes.
datapoints.rebuild_started_atgoogle.protobuf.TimestampIf not a zero timestamp, identifies the start time (in UTC) of the previous rebuild.
datapoints.rebuild_completed_atgoogle.protobuf.TimestampIf not a zero timestamp, identifies the completion time (in UTC) of the previous rebuild. Set indexingmode to eimRebuild to indicate an ongoing rebuild.

Response: PushDatapointsForIndexingCommonResponse

No fields.