OperationMeta class final
One operation, exactly as the generated ops.dart declares it.
Constructors
-
OperationMeta({required String id, required String method, required String path, String? entity, String? rootType, Duration? staleTime, List<
String> provides = const [], List<String> invalidates = const [], List<String> security = const [], WireCodec? bodyCodec, WireCodec? responseCodec, bool idempotent = false, String? requestContentType}) -
Creates an operation row. Generated code declares these as
const.const
Properties
- bodyCodec → WireCodec?
-
Renames the request body from client shape to wire shape.
final
- entity → String?
-
The entity this operation's cache contract is about.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
The generated table key, e.g.
op_get_order. Used by the outbox to turn a persisted operation back into its row. The cache keys queries by method and path, as TypeScript does, so cache keys match across runtimes.final - idempotent → bool
-
Whether the route uses Forge's idempotency middleware
(
x-forge-idempotent). Read by the outbox; the transport does not retry on it.final -
invalidates
→ List<
String> -
Tag templates this operation invalidates.
final
- method → String
-
The HTTP method, upper case.
final
- path → String
-
The path template, e.g.
/orders/{id}.final -
provides
→ List<
String> -
Tag templates this operation provides.
final
- requestContentType → String?
-
The content type the request body is sent as. Null means JSON, which is
what every row without a body, or with a plain
application/jsonbody, leaves it as.final - responseCodec → WireCodec?
-
Renames the response from wire shape to client shape.
final
- rootType → String?
-
The typename of the response document (of its elements for a bare
list). Indexes the entities table when normalizing a response; falls back
to entity when absent.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
security
→ List<
String> -
The security scheme names this operation declares.
final
- staleTime → Duration?
-
How long this operation's result stays fresh. Null means "use the cache
default".
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited