Class JavaScriptUDF (1.147.0)

Version latest

• 1.147.0 (latest)
• 1.145.0
• 1.143.1
• 1.142.0
• 1.141.5
• 1.140.2
• 1.139.4
• 1.138.0
• 1.137.1
• 1.136.1
• 1.135.0
• 1.134.2
• 1.133.1
• 1.132.2
• 1.131.0
• 1.130.0
• 1.129.6
• 1.127.3
• 1.126.6
• 1.125.13
• 1.123.18
• 1.122.2
• 1.121.1
• 1.120.24
• 1.119.1
• 1.118.0
• 1.117.0
• 1.116.4
• 1.115.5

public final class JavaScriptUDF extends GeneratedMessage implements JavaScriptUDFOrBuilder

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

Protobuf type google.pubsub.v1.JavaScriptUDF

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > JavaScriptUDF

Implements

JavaScriptUDFOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CODE_FIELD_NUMBER

public static final int CODE_FIELD_NUMBER

Field Value
Type	Description
int

FUNCTION_NAME_FIELD_NUMBER

public static final int FUNCTION_NAME_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static JavaScriptUDF getDefaultInstance()

Returns
Type	Description
JavaScriptUDF

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static JavaScriptUDF.Builder newBuilder()

Returns
Type	Description
JavaScriptUDF.Builder

newBuilder(JavaScriptUDF prototype)

public static JavaScriptUDF.Builder newBuilder(JavaScriptUDF prototype)

Parameter
Name	Description
prototype	JavaScriptUDF

Returns
Type	Description
JavaScriptUDF.Builder

parseDelimitedFrom(InputStream input)

public static JavaScriptUDF parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
JavaScriptUDF

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static JavaScriptUDF parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
JavaScriptUDF

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static JavaScriptUDF parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
JavaScriptUDF

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static JavaScriptUDF parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
JavaScriptUDF

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static JavaScriptUDF parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
JavaScriptUDF

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static JavaScriptUDF parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
JavaScriptUDF

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static JavaScriptUDF parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
JavaScriptUDF

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static JavaScriptUDF parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
JavaScriptUDF

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static JavaScriptUDF parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
JavaScriptUDF

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static JavaScriptUDF parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
JavaScriptUDF

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static JavaScriptUDF parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
JavaScriptUDF

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static JavaScriptUDF parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
JavaScriptUDF

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<JavaScriptUDF> parser()

Returns
Type	Description
Parser<JavaScriptUDF>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getCode()

public 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
Type	Description
String	The code.

getCodeBytes()

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

getDefaultInstanceForType()

public JavaScriptUDF getDefaultInstanceForType()

Returns
Type	Description
JavaScriptUDF

getFunctionName()

public 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 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.

getParserForType()

public Parser<JavaScriptUDF> getParserForType()

Returns
Type	Description
Parser<JavaScriptUDF>

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public JavaScriptUDF.Builder newBuilderForType()

Returns
Type	Description
JavaScriptUDF.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected JavaScriptUDF.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
JavaScriptUDF.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public JavaScriptUDF.Builder toBuilder()

Returns
Type	Description
JavaScriptUDF.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException