Package com.google.pubsub.v1

Interface JavaScriptUDFOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

JavaScriptUDF, JavaScriptUDF.Builder

public interface JavaScriptUDFOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
String	getCode()	Required.
com.google.protobuf.ByteString	getCodeBytes()	Required.
String	getFunctionName()	Required.
com.google.protobuf.ByteString	getFunctionNameBytes()	Required.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

getFunctionName

String getFunctionName()

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

string function_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The functionName.

getFunctionNameBytes

com.google.protobuf.ByteString getFunctionNameBytes()

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

string function_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for functionName.

getCode

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

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

string code = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The code.

getCodeBytes

com.google.protobuf.ByteString getCodeBytes()

 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) {
   }
 ```
 

string code = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for code.