Skip to content

Operations

rn_forge.web.operations

Long-running operations in the AIP-151 shape, with an RFC 9457 error.

Operation

Bases: WireModel

The resource a long-running call returns and a client polls.

The call answers 202 with a Location naming this resource. While done is false neither error nor response is set; once it is true exactly one of them is. Absent members are omitted from the body.

Example

Operation(name="operations/7", done=True, response={"id": "1"}).as_body() returns {"name": "operations/7", "done": True, "response": {"id": "1"}}.

Raises:

Type Description
ValidationError

When done is false and an outcome is set, or true and not exactly one is.

as_body()

Return the wire body, camelCase, omitting absent members.