Reference documentation and code samples for the Google Cloud BigQuery Analytics Hub V1 Client class JavaScriptUDF.
User-defined JavaScript function that can transform or filter a Pub/Sub message.
Generated from protobuf message google.cloud.bigquery.analyticshub.v1.JavaScriptUDF
Namespace
Google \ Cloud \ BigQuery \ AnalyticsHub \ V1Methods
__construct
Constructor.
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.
string
setFunctionName
Required. Name of the JavasScript function that should applied to Pub/Sub messages.
var
string
$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) {
}
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) {
}
var
string
$this
