Struct RunFunctionRequest 

pub struct RunFunctionRequest {
    pub meta: Option<RequestMeta>,
    pub observed: Option<State>,
    pub desired: Option<State>,
    pub input: Option<Struct>,
    pub context: Option<Struct>,
    pub extra_resources: HashMap<String, Resources>,
    pub credentials: HashMap<String, Credentials>,
    pub required_resources: HashMap<String, Resources>,
    pub required_schemas: HashMap<String, Schema>,
}

A RunFunctionRequest requests that the function be run.

Fields

meta: Option<RequestMeta>

Metadata pertaining to this request.

observed: Option<State>

The observed state prior to invocation of a function pipeline. State passed to each function is fresh as of the time the pipeline was invoked, not as of the time each function was invoked.

desired: Option<State>

Desired state according to a function pipeline. The state passed to a particular function may have been accumulated by previous functions in the pipeline.

Note that the desired state must be a partial object with only the fields that this function (and its predecessors in the pipeline) wants to have set in the object. Copying a non-partial observed state to desired is most likely not what you want to do. Leaving out fields that had been returned as desired before will result in them being deleted from the objects in the cluster.

input: Option<Struct>

Optional input specific to this function invocation. A JSON representation of the ‘input’ block of the relevant entry in a function pipeline.

context: Option<Struct>

Optional context. Crossplane may pass arbitrary contextual information to a function. A function may also return context in its RunFunctionResponse, and that context will be passed to subsequent functions. Crossplane discards all context returned by the last function in the pipeline.

extra_resources: HashMap<String, Resources>

Optional resources that the function specified in its requirements. Note that resources is a map to Resources, plural. The map key corresponds to the key in a RunFunctionResponse’s requirements.extra_resources field. If a function requested extra resources that did not exist, Crossplane sets the map key to an empty Resources message to indicate that it attempted to satisfy the request. This field is only populated when the function uses extra_resources in its requirements.

Deprecated: Use required_resources instead.

credentials: HashMap<String, Credentials>

Optional credentials that this function may use to communicate with an external system.

required_resources: HashMap<String, Resources>

Optional resources that the function specified in its requirements. Note that resources is a map to Resources, plural. The map key corresponds to the key in a RunFunctionResponse’s requirements.resources field. If a function requested required resources that did not exist, Crossplane sets the map key to an empty Resources message to indicate that it attempted to satisfy the request. This field is only populated when the function uses resources in its requirements.

required_schemas: HashMap<String, Schema>

Optional schemas that the function specified in its requirements. The map key corresponds to the key in a RunFunctionResponse’s requirements.schemas field. If a function requested a schema that could not be found, Crossplane sets the map key to an empty Schema message to indicate that it attempted to satisfy the request.

Trait Implementations

impl Clone for RunFunctionRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunFunctionRequest

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

Formats the value using the given formatter.

impl Default for RunFunctionRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RunFunctionRequest

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for RunFunctionRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for RunFunctionRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RunFunctionRequest

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RunFunctionRequest