Interface JavaScriptUDFOrBuilder (1.137.0)

public interface JavaScriptUDFOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCode()

public abstract 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:

(required) '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
Type	Description
`String`	The code.

getCodeBytes()

public abstract 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:

(required) '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
Type	Description
`ByteString`	The bytes for code.

getFunctionName()

public abstract 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
Type	Description
`String`	The functionName.

getFunctionNameBytes()

public abstract 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
Type	Description
`ByteString`	The bytes for functionName.