Cloud PubSub V1 Client - Class JavaScriptUDF (2.10.0)

Reference documentation and code samples for the Cloud PubSub V1 Client class JavaScriptUDF.

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

Generated from protobuf message google.pubsub.v1.JavaScriptUDF

Namespace

Google \ Cloud \ PubSub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ 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: * * - (required) 'message_id' : {string} * * - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * * - (optional) 'ordering_key': {string} */ function <function_name>(message, metadata) { }

getFunctionName

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

Returns
Type Description
string

setFunctionName

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

Parameter
Name Description
var string
Returns
Type Description
$this

getCode

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
Type Description
string

setCode

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) { }
Parameter
Name Description
var string
Returns
Type Description
$this