IRPCVault.GetMetadataStructureVersion

View as Markdown

Vault API / core read session or assertion idempotent

Gets the version numbers of the vault's metadata structure and of its property definitions.

ServiceVault information MFiles.IRPCVault
gRPC method/MFiles.IRPCVault/GetMetadataStructureVersion
HTTP (mf-http-grpc)POST /grpc/v1/get-metadata-structure-version
RequestGetMetadataStructureVersionRequest
ResponseGetMetadataStructureVersionResponse
Book and levelVault API, core
Kindread
SessionRequired: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata).
Idempotentyes
Returns metadata structure versionno
Streamingnone (unary)

Remarks

A cheap check for structure changes. metadata_structure_version is the same number that other methods return in the mfiles-metadata-version-bin trailer. This method itself sends no trailer.

Request: GetMetadataStructureVersionRequest

No fields.

Response: GetMetadataStructureVersionResponse

A structure that specifies the response type for the GetMetadataStructureVersion method.

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

FieldTypeDescription
metadata_structure_versionint32The vault's metadata structure version. When it differs from the value your cache was built with, refresh cached structure data.
property_defs_versionint32The version of the vault's property definitions.