IRPCDeclarativeMetadataStructure.PauseDeclarativeMetadataStructureRevisionGeneration
Administration API / specialized admin session returns metadata structure version
Starts, extends or reads a pause of automatic revision generation for the calling session.
While the pause is active, structure changes made by this session do not each generate a new revision of the declarative metadata structure. When the pause ends, by CancelDeclarativeMetadataStructureRevisionGenerationPause or by expiry, the server generates one catch-up revision.
| Service | Declarative metadata structure MFiles.IRPCDeclarativeMetadataStructure |
|---|---|
| gRPC method | /MFiles.IRPCDeclarativeMetadataStructure/PauseDeclarativeMetadataStructureRevisionGeneration |
| HTTP (mf-http-grpc) | POST /grpc/v1/pause-declarative-metadata-structure-revision-generation |
| Request | PauseDeclarativeMetadataStructureRevisionGenerationRequest |
| Response | PauseDeclarativeMetadataStructureRevisionGenerationResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
- Fails with "Not implemented." unless local revision generation is enabled on the server.
- Requires
change_metadata_structure. - A positive
duration_secondsstarts a pause, or extends this session's pause (never shortens it). 0 only reads the remaining time and changes nothing. A negative value or more than 3600 fails with an invalid-argument error. - Each session has at most one pause, identified by the session itself; other sessions are not affected.
Request: PauseDeclarativeMetadataStructureRevisionGenerationRequest
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 |
|---|---|---|
duration_seconds | int32 | The pause length in seconds, 1 to 3600, or 0 to read the status only. |
Response: PauseDeclarativeMetadataStructureRevisionGenerationResponse
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 |
|---|---|---|
remaining_seconds | int32 | Seconds left on this session's pause, rounded up. 0 means no active pause. |
Related methods
- CancelDeclarativeMetadataStructureRevisionGenerationPause -- Ends the calling session's pause of automatic revision generation.