Class JavaScriptUDF (1.139.4)
Version 1.139.4keyboard_arrow_down
public final class JavaScriptUDF extends GeneratedMessageV3 implements JavaScriptUDFOrBuilder
User-defined JavaScript function that can transform or filter a Pub/Sub
message.
Protobuf type google.pubsub.v1.JavaScriptUDF
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static JavaScriptUDF . Builder newBuilder ()
newBuilder(JavaScriptUDF prototype)
public static JavaScriptUDF . Builder newBuilder ( JavaScriptUDF prototype )
public static JavaScriptUDF parseDelimitedFrom ( InputStream input )
public static JavaScriptUDF parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static JavaScriptUDF parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static JavaScriptUDF parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static JavaScriptUDF parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static JavaScriptUDF parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static JavaScriptUDF parseFrom ( CodedInputStream input )
public static JavaScriptUDF parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static JavaScriptUDF parseFrom ( InputStream input )
public static JavaScriptUDF parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static JavaScriptUDF parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static JavaScriptUDF parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<JavaScriptUDF> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
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 ()
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 ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public JavaScriptUDF . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected JavaScriptUDF . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public JavaScriptUDF . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
