Struct protos::sp_sdk::SDKResponse

pub struct SDKResponse {
    pub data: Vec<u8>,
    pub status: EnumOrUnknown<ExecStatus>,
    pub status_message: Option<String>,
    pub pipeline_status: Vec<PipelineStatus>,
    pub metadata: HashMap<String, String>,
    pub sdk_mode: EnumOrUnknown<SDKMode>,
    pub special_fields: SpecialFields,
}

Common return response used by all SDKs

Fields

data: Vec<u8>

Contains (potentially) modified input data

status: EnumOrUnknown<ExecStatus>

Execution status of the last step

status_message: Option<String>

Optional message accompanying the exec status for the last step

pipeline_status: Vec<PipelineStatus>

An array of pipelines that the SDK executed and the status of each step

metadata: HashMap<String, String>

Includes any metadata that the step(s) may want to pass back to the user.

NOTE: Metadata is aggregated across all steps in the pipeline, so if two steps both set a key “foo” to different values, the value of “foo” in the response will be the value set by the last step in the pipeline.

To learn more about “metadata”, see SDK Spec V2 doc “Pipeline Step & Error Behavior” section.

sdk_mode: EnumOrUnknown<SDKMode>

SDKMode is purely an informative field that tells the user the mode that the SDK was running in when the response was generated.

special_fields: SpecialFields

Implementations

impl SDKResponse

pub fn new() -> SDKResponse

Trait Implementations

impl Clone for SDKResponse

fn clone(&self) -> SDKResponse

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SDKResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Default for &'a SDKResponse

fn default() -> &'a SDKResponse

Returns the “default value” for a type.

impl Default for SDKResponse

fn default() -> SDKResponse

Returns the “default value” for a type.

impl Display for SDKResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Message for SDKResponse

const NAME: &'static str = "SDKResponse"

Message name as specified in .proto file.

fn is_initialized(&self) -> bool

True iff all required fields are initialized. Always returns true for protobuf 3.

fn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> Result<()>

Update this message object with fields read from given stream.

fn compute_size(&self) -> u64

Compute and cache size of this message and all nested messages.

fn write_to_with_cached_sizes( &self, os: &mut CodedOutputStream<'_> ) -> Result<()>

Write message to the stream.

fn special_fields(&self) -> &SpecialFields

Special fields (unknown fields and cached size).

fn mut_special_fields(&mut self) -> &mut SpecialFields

Special fields (unknown fields and cached size).

fn new() -> SDKResponse

Create an empty message object.

fn clear(&mut self)

Reset all fields.

fn default_instance() -> &'static SDKResponse

Return a pointer to default immutable message with static lifetime.

fn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self, Error>

Parse message from stream.

fn cached_size(&self) -> u32

Get size previously computed by compute_size.

fn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<(), Error>

Write the message to the stream.

fn write_length_delimited_to( &self, os: &mut CodedOutputStream<'_> ) -> Result<(), Error>

Write the message to the stream prepending the message with message length encoded as varint.

fn write_length_delimited_to_vec(&self, vec: &mut Vec<u8>) -> Result<(), Error>

Write the message to the vec, prepend the message with message length encoded as varint.

fn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<(), Error>

Update this message object with fields read from given stream.

fn parse_from_reader(reader: &mut dyn Read) -> Result<Self, Error>

Parse message from reader. Parse stops on EOF or when error encountered.

fn parse_from_bytes(bytes: &[u8]) -> Result<Self, Error>

Parse message from byte array.

fn check_initialized(&self) -> Result<(), Error>

Check if all required fields of this object are initialized.

fn write_to_writer(&self, w: &mut dyn Write) -> Result<(), Error>

Write the message to the writer.

fn write_to_vec(&self, v: &mut Vec<u8>) -> Result<(), Error>

Write the message to bytes vec.

fn write_to_bytes(&self) -> Result<Vec<u8>, Error>

Write the message to bytes vec.

fn write_length_delimited_to_writer( &self, w: &mut dyn Write ) -> Result<(), Error>

Write the message to the writer, prepend the message with message length encoded as varint.

fn write_length_delimited_to_bytes(&self) -> Result<Vec<u8>, Error>

Write the message to the bytes vec, prepend the message with message length encoded as varint.

fn unknown_fields(&self) -> &UnknownFields

Get a reference to unknown fields.

fn mut_unknown_fields(&mut self) -> &mut UnknownFields

Get a mutable reference to unknown fields.

impl MessageFull for SDKResponse

fn descriptor() -> MessageDescriptor

Get message descriptor for message type.

fn reflect_eq(&self, other: &Self, mode: &ReflectEqMode) -> bool

Reflective equality.

impl PartialEq for SDKResponse

fn eq(&self, other: &SDKResponse) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ProtobufValue for SDKResponse

type RuntimeType = RuntimeTypeMessage<SDKResponse>

Actual implementation of type properties.

impl StructuralPartialEq for SDKResponse