Packages

c

com.google.pubsub.v1

JavaScriptUDF

final class JavaScriptUDF extends GeneratedMessageV3 with JavaScriptUDFOrBuilder

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

Protobuf type google.pubsub.v1.JavaScriptUDF

Source
JavaScriptUDF.java
Linear Supertypes
JavaScriptUDFOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JavaScriptUDF
  2. JavaScriptUDFOrBuilder
  3. GeneratedMessageV3
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(obj: AnyRef): Boolean
    Definition Classes
    JavaScriptUDF → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  10. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def getCode(): 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) {
  }
```


    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

    The code.

    Definition Classes
    JavaScriptUDF → JavaScriptUDFOrBuilder
    Annotations
    @Override()
  13. def getCodeBytes(): ByteString

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


    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

    The bytes for code.

    Definition Classes
    JavaScriptUDF → JavaScriptUDFOrBuilder
    Annotations
    @Override()
  14. def getDefaultInstanceForType(): JavaScriptUDF
    Definition Classes
    JavaScriptUDF → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  15. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  16. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  17. def getFunctionName(): String

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


    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.

    Definition Classes
    JavaScriptUDF → JavaScriptUDFOrBuilder
    Annotations
    @Override()
  18. def getFunctionNameBytes(): ByteString

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


    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.

    Definition Classes
    JavaScriptUDF → JavaScriptUDFOrBuilder
    Annotations
    @Override()
  19. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  20. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  21. def getParserForType(): Parser[JavaScriptUDF]
    Definition Classes
    JavaScriptUDF → GeneratedMessageV3 → Message → MessageLite
    Annotations
    @Override()
  22. def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  23. def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  24. def getSerializedSize(): Int
    Definition Classes
    JavaScriptUDF → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  25. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  26. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  27. def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  28. def hashCode(): Int
    Definition Classes
    JavaScriptUDF → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  29. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[v1]
    Definition Classes
    JavaScriptUDF → GeneratedMessageV3
    Annotations
    @Override()
  30. def internalGetMapField(arg0: Int): MapField[_ <: AnyRef, _ <: AnyRef]
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  31. final def isInitialized(): Boolean
    Definition Classes
    JavaScriptUDF → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  32. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  33. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[v1]
    Definition Classes
    JavaScriptUDF → GeneratedMessageV3
    Annotations
    @Override()
  36. def newBuilderForType(): Builder
    Definition Classes
    JavaScriptUDF → Message → MessageLite
    Annotations
    @Override()
  37. def newBuilderForType(arg0: BuilderParent): Builder
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  38. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[v1]
    Definition Classes
    JavaScriptUDF → GeneratedMessageV3
    Annotations
    @Override() @SuppressWarnings()
  39. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  40. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  41. def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  42. def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  43. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  44. def toBuilder(): Builder
    Definition Classes
    JavaScriptUDF → Message → MessageLite
    Annotations
    @Override()
  45. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  46. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  47. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  48. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  50. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  51. def writeDelimitedTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  52. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.ObjectStreamException])
  53. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    JavaScriptUDF → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  54. def writeTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])

Deprecated Value Members

  1. def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
    Deprecated

Inherited from JavaScriptUDFOrBuilder

Inherited from GeneratedMessageV3

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped