class documentation

A normalized representation of an RPC status.

Class Method from_rpc_status Create a RequestStatus from a gRPC Status proto.
Method to_rpc_status Convert this object into a google.rpc.status_pb2.Status.
Instance Variable code gRPC status code
Instance Variable details list of google.protobuf.Any detail messages
Instance Variable message human readable message (may be None)
Instance Variable request_id request identifier extracted from metadata
Instance Variable trace_id trace identifier extracted from metadata
@classmethod
def from_rpc_status(cls, status: StatusPb, request_id: str, trace_id: str) -> RequestStatus: (source)

Create a RequestStatus from a gRPC Status proto.

Parameters
status:StatusPbthe protobuf status message
request_id:strrequest id extracted separately from metadata
trace_id:strtrace id extracted separately from metadata
Returns
RequestStatusa populated RequestStatus instance
def to_rpc_status(self) -> StatusPb: (source)

Convert this object into a google.rpc.status_pb2.Status.

This is primarily used when the SDK needs to interoperate with gRPC-based status helpers.

details: list[AnyPb] = (source)

list of google.protobuf.Any detail messages

message: str | None = (source)

human readable message (may be None)

request_id: str = (source)

request identifier extracted from metadata

trace_id: str = (source)

trace identifier extracted from metadata