com.google.cloud.bigquery.analyticshub.v1

Class JavaScriptUDF

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.bigquery.analyticshub.v1.JavaScriptUDF

All Implemented Interfaces:

JavaScriptUDFOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class JavaScriptUDF
extends com.google.protobuf.GeneratedMessageV3
implements JavaScriptUDFOrBuilder

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

Protobuf type google.cloud.bigquery.analyticshub.v1.JavaScriptUDF

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavaScriptUDF.Builder User-defined JavaScript function that can transform or filter a Pub/Sub message.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CODE_FIELD_NUMBER
static int	FUNCTION_NAME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCode() Required.
com.google.protobuf.ByteString	getCodeBytes() Required.
static JavaScriptUDF	getDefaultInstance()
JavaScriptUDF	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFunctionName() Required.
com.google.protobuf.ByteString	getFunctionNameBytes() Required.
com.google.protobuf.Parser<JavaScriptUDF>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static JavaScriptUDF.Builder	newBuilder()
static JavaScriptUDF.Builder	newBuilder(JavaScriptUDF prototype)
JavaScriptUDF.Builder	newBuilderForType()
protected JavaScriptUDF.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static JavaScriptUDF	parseDelimitedFrom(InputStream input)
static JavaScriptUDF	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static JavaScriptUDF	parseFrom(byte[] data)
static JavaScriptUDF	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static JavaScriptUDF	parseFrom(ByteBuffer data)
static JavaScriptUDF	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static JavaScriptUDF	parseFrom(com.google.protobuf.ByteString data)
static JavaScriptUDF	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static JavaScriptUDF	parseFrom(com.google.protobuf.CodedInputStream input)
static JavaScriptUDF	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static JavaScriptUDF	parseFrom(InputStream input)
static JavaScriptUDF	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<JavaScriptUDF>	parser()
JavaScriptUDF.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

FUNCTION_NAME_FIELD_NUMBER

public static final int FUNCTION_NAME_FIELD_NUMBER

See Also:

Constant Field Values

CODE_FIELD_NUMBER

public static final int CODE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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

Specified by:

getFunctionName in interface JavaScriptUDFOrBuilder

Returns:

The functionName.

getFunctionNameBytes

public com.google.protobuf.ByteString getFunctionNameBytes()

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

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

Specified by:

getFunctionNameBytes in interface JavaScriptUDFOrBuilder

Returns:

The bytes for functionName.

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:
   *   - (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];

Specified by:

getCode in interface JavaScriptUDFOrBuilder

Returns:

The code.

getCodeBytes

public com.google.protobuf.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:
   *   - (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];

Specified by:

getCodeBytes in interface JavaScriptUDFOrBuilder

Returns:

The bytes for code.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static JavaScriptUDF parseFrom(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static JavaScriptUDF parseFrom(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static JavaScriptUDF parseFrom(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static JavaScriptUDF parseFrom(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static JavaScriptUDF parseFrom(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static JavaScriptUDF parseFrom(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static JavaScriptUDF parseFrom(InputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static JavaScriptUDF parseFrom(InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static JavaScriptUDF parseDelimitedFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static JavaScriptUDF parseDelimitedFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

parseFrom

public static JavaScriptUDF parseFrom(com.google.protobuf.CodedInputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static JavaScriptUDF parseFrom(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

newBuilderForType

public JavaScriptUDF.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static JavaScriptUDF.Builder newBuilder()

newBuilder

public static JavaScriptUDF.Builder newBuilder(JavaScriptUDF prototype)

toBuilder

public JavaScriptUDF.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected JavaScriptUDF.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static JavaScriptUDF getDefaultInstance()

parser

public static com.google.protobuf.Parser<JavaScriptUDF> parser()

getParserForType

public com.google.protobuf.Parser<JavaScriptUDF> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public JavaScriptUDF getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder