Cloud Pub/Sub v1 API - Class JavaScriptUDF (3.27.0) 

public sealed class JavaScriptUDF : IMessage<JavaScriptUDF>, IEquatable<JavaScriptUDF>, IDeepCloneable<JavaScriptUDF>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Pub/Sub v1 API class JavaScriptUDF.

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

Inheritance

object > JavaScriptUDF

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

JavaScriptUDF()

public JavaScriptUDF()

JavaScriptUDF(JavaScriptUDF)

public JavaScriptUDF(JavaScriptUDF other)
Parameter
Name Description
other JavaScriptUDF

Properties

Code

public string Code { get; set; }

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) {
  }
Property Value
Type Description
string

FunctionName

public string FunctionName { get; set; }

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

Property Value
Type Description
string