jina.types.request package#
Submodules#
Module contents#
- class jina.types.request.Request[source]#
Bases:
jina.types.mixin.ProtoTypeMixinRequestis one of the primitive data types in Jina, and serves as a base forDataRequestandResponse.It offers a Pythonic interface to allow users access and manipulate
jina.jina_pb2.RequestProtoobject without working with Protobuf itself.It serves as a container for serialized
jina_pb2.RequestProtothat only triggers deserialization and decompression when receives the first read access to its member.It overrides
__getattr__()to provide the same get/set interface as anjina_pb2.RequestProtoobject.- add_exception(ex=None, executor=None)[source]#
Add exception to the last route in the envelope :type ex:
Optional[Exception] :param ex: Exception to be added :type executor:Optional[BaseExecutor] :param executor: Executor related to the exception- Return type
None
- CopyFrom(other)#
Copy the content of target
- Parameters
other (
TypeVar(T)) – the document to copy from- Return type
None
- MergeFrom(other)#
Merge the content of target
- Parameters
other (
TypeVar(T)) – the document to merge from- Return type
None
- binary_str(**kwargs)#
- clear()#
Remove all values from all fields of this Document.
- Return type
None
- dict(**kwargs)#
- json(**kwargs)#
- property nbytes: int#
Return total bytes consumed by protobuf.
- Return type
int- Returns
number of bytes
- pop(*fields)#
Remove the values from the given fields of this Document.
- Parameters
fields – field names
- Return type
None
- property proto: google.protobuf.pyext.cpp_message.GeneratedProtocolMessageType#
Return the underlying Protobuf object
- Return type
GeneratedProtocolMessageType- Returns
Protobuf representation of the object
- to_bytes()#
Return the serialized the message to a string.
For more Pythonic code, please use
bytes(...).- Return type
bytes- Returns
binary string representation of the object
- to_dict(**kwargs)#
Return the object in Python dictionary.
Note
Array like object such as
numpy.ndarray(i.e. anything described asjina_pb2.NdArrayProto) will be converted to Python list.- Parameters
kwargs – Extra kwargs to be passed to MessageToDict, like use_integers_for_enums
- Return type
Dict- Returns
dict representation of the object
- to_json()#
Return the object in JSON string
- Return type
str- Returns
JSON string of the object
