# Cloud Pub/Sub v1 API - Class JavaScriptUDF (3.36.0)

3.36.0 (latest) 3.35.0 3.34.0 3.33.0 3.32.0 3.31.0 3.30.0 3.29.0 3.28.0 3.27.0 3.26.0 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.1 3.9.1 3.8.0 3.7.0 3.6.0 3.5.1 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.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](https://learn.microsoft.com/dotnet/api/system.object) \> JavaScriptUDF

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[JavaScriptUDF](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.JavaScriptUDF), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[JavaScriptUDF](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.JavaScriptUDF), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[JavaScriptUDF](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.JavaScriptUDF), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.PubSub.V1](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1)

## Assembly

Google.Cloud.PubSub.V1.dll

## Constructors

### JavaScriptUDF()

    public JavaScriptUDF()

### JavaScriptUDF(JavaScriptUDF)

    public JavaScriptUDF(JavaScriptUDF other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.PubSub.V1/latest/Google.Cloud.PubSub.V1.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** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### FunctionName

    public string FunctionName { get; set; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |