nexusrpc.handler.StartOperationContext

class documentation

class StartOperationContext(OperationContext):

Constructor: StartOperationContext(*args, **kwargs)

Context for the start method.

Includes information from the request.

Class Variable	`callback_headers`	Optional header fields set by the caller to be attached to the callback request when an asynchronous operation completes.
Class Variable	`callback_url`	A callback URL is required to deliver the completion of an async operation. This URL should be called by a handler upon completion if the started operation is async.
Class Variable	`inbound_links`	Links received in the request. This list is automatically populated when handling a start request. Handlers may use these links, for example to add information about the caller to a resource associated with the operation execution.
Class Variable	`outbound_links`	Links to be returned by the handler. This list is initially empty. Handlers may populate this list, for example with links describing resources associated with the operation execution that may be of use to the caller.
Class Variable	`request_id`	Request ID that may be used by the handler to dedupe a start request. By default a v4 UUID should be generated by the client.

Inherited from OperationContext:

Method	`__new__`	Undocumented
Class Variable	`headers`	Optional header fields sent by the caller.
Class Variable	`operation`	The name of the operation.
Class Variable	`service`	The name of the service that the operation belongs to.

callback_headers: Mapping[str, str] = ¶

Optional header fields set by the caller to be attached to the callback request when an asynchronous operation completes.

callback_url: str | None = ¶

A callback URL is required to deliver the completion of an async operation. This URL should be called by a handler upon completion if the started operation is async.

inbound_links: Sequence[Link] = ¶

Links received in the request. This list is automatically populated when handling a start request. Handlers may use these links, for example to add information about the caller to a resource associated with the operation execution.

outbound_links: list[Link] = ¶

Links to be returned by the handler. This list is initially empty. Handlers may populate this list, for example with links describing resources associated with the operation execution that may be of use to the caller.

request_id: str = ¶

Request ID that may be used by the handler to dedupe a start request. By default a v4 UUID should be generated by the client.