Struct JavaScriptUDF 

#[non_exhaustive]
pub struct JavaScriptUDF {
    pub function_name: String,
    pub code: String,
    /* private fields */
}

User-defined JavaScript function that can transform or filter a Pub/Sub message.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

function_name: String

Required. Name of the JavasScript function that should applied to Pub/Sub messages.

code: String

Required. JavaScript code that contains a function function_name with the below signature:

  /**
  * Transforms a Pub/Sub message.

  * @return {(Object<string, (string | Object<string, string>)>|null)} - To
  * filter a message, return `null`. To transform a message return a map
  * with the following keys:
  *   - (required) 'data' : {string}
  *   - (optional) 'attributes' : {Object<string, string>}
  * Returning empty `attributes` will remove all attributes from the
  * message.
  *
  * @param  {(Object<string, (string | Object<string, string>)>} Pub/Sub
  * message. Keys:
  *   - (required) 'data' : {string}
  *   - (required) 'attributes' : {Object<string, string>}
  *
  * @param  {Object<string, any>} metadata - Pub/Sub message metadata.
  * Keys:
  *   - (optional) 'message_id'  : {string}
  *   - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format
  *   - (optional) 'ordering_key': {string}
  */

  function <function_name>(message, metadata) {
  }

Implementations

impl JavaScriptUDF

pub fn new() -> Self

pub fn set_function_name<T: Into<String>>(self, v: T) -> Self

Sets the value of function_name.

Example

let x = JavaScriptUDF::new().set_function_name("example");

pub fn set_code<T: Into<String>>(self, v: T) -> Self

Sets the value of code.

Example

let x = JavaScriptUDF::new().set_code("example");

Trait Implementations

impl Clone for JavaScriptUDF

fn clone(&self) -> JavaScriptUDF

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JavaScriptUDF

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

Formats the value using the given formatter.

impl Default for JavaScriptUDF

fn default() -> JavaScriptUDF

Returns the “default value” for a type.

impl Message for JavaScriptUDF

fn typename() -> &'static str

The typename of this message.

impl PartialEq for JavaScriptUDF

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for JavaScriptUDF