Class: Google::Cloud::PubSub::V1::JavaScriptUDF

Inherits:

Object

• Object
• Google::Cloud::PubSub::V1::JavaScriptUDF

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/pubsub/v1/pubsub.rb

Overview

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

Instance Attribute Summary

• #code ⇒ ::String

  Required.

• #function_name ⇒ ::String

  Required.

Instance Attribute Details

#code ⇒ ::String

Returns 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:
  *   - (required) 'message_id'  : \\{string}
  *   - (optional) 'publish_time': \\{string} YYYY-MM-DDTHH:MM:SSZ format
  *   - (optional) 'ordering_key': \\{string}
  */

  function <function_name>(message, metadata) {
  }
```.

Returns:

• (::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:
    *   - (required) 'message_id'  : \\{string}
    *   - (optional) 'publish_time': \\{string} YYYY-MM-DDTHH:MM:SSZ format
    *   - (optional) 'ordering_key': \\{string}
    */
  
    function <function_name>(message, metadata) {
    }
  

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 649

class JavaScriptUDF
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#function_name ⇒ ::String

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

Returns:

• (::String) —

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

# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 649

class JavaScriptUDF
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end