Class JavaScriptUDF.Builder (1.142.0)

public static final class JavaScriptUDF.Builder extends GeneratedMessageV3.Builder<JavaScriptUDF.Builder> implements JavaScriptUDFOrBuilder

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

Protobuf type google.pubsub.v1.JavaScriptUDF

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > JavaScriptUDF.Builder

Implements

JavaScriptUDFOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public JavaScriptUDF.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`JavaScriptUDF.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public JavaScriptUDF build()

Returns
Type	Description
`JavaScriptUDF`

buildPartial()

public JavaScriptUDF buildPartial()

Returns
Type	Description
`JavaScriptUDF`

clear()

public JavaScriptUDF.Builder clear()

Returns
Type	Description
`JavaScriptUDF.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCode()

public JavaScriptUDF.Builder clearCode()

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
`JavaScriptUDF.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public JavaScriptUDF.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`JavaScriptUDF.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFunctionName()

public JavaScriptUDF.Builder clearFunctionName()

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
`JavaScriptUDF.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public JavaScriptUDF.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`JavaScriptUDF.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public JavaScriptUDF.Builder clone()

Returns
Type	Description
`JavaScriptUDF.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public JavaScriptUDF.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`JavaScriptUDF.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public JavaScriptUDF.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`JavaScriptUDF.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeFrom(JavaScriptUDF other)

public JavaScriptUDF.Builder mergeFrom(JavaScriptUDF other)

Parameter
Name	Description
`other`	`JavaScriptUDF`

Returns
Type	Description
`JavaScriptUDF.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final JavaScriptUDF.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`JavaScriptUDF.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setCode(String value)

public JavaScriptUDF.Builder setCode(String value)

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];

Parameter
Name	Description
`value`	`String` The code to set.

Returns
Type	Description
`JavaScriptUDF.Builder`	This builder for chaining.

setCodeBytes(ByteString value)

public JavaScriptUDF.Builder setCodeBytes(ByteString value)

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];

Parameter
Name	Description
`value`	`ByteString` The bytes for code to set.

Returns
Type	Description
`JavaScriptUDF.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public JavaScriptUDF.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`JavaScriptUDF.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFunctionName(String value)

public JavaScriptUDF.Builder setFunctionName(String value)

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

string function_name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`String` The functionName to set.

Returns
Type	Description
`JavaScriptUDF.Builder`	This builder for chaining.

setFunctionNameBytes(ByteString value)

public JavaScriptUDF.Builder setFunctionNameBytes(ByteString value)

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

string function_name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`ByteString` The bytes for functionName to set.

Returns
Type	Description
`JavaScriptUDF.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public JavaScriptUDF.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`JavaScriptUDF.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final JavaScriptUDF.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`JavaScriptUDF.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)