- 0.80.0 (latest)
- 0.79.0
- 0.78.0
- 0.77.0
- 0.75.0
- 0.73.0
- 0.72.0
- 0.71.0
- 0.70.0
- 0.69.0
- 0.67.0
- 0.65.0
- 0.64.0
- 0.61.0
- 0.60.0
- 0.59.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public final class JavaScriptUDF extends GeneratedMessage implements JavaScriptUDFOrBuilderUser-defined JavaScript function that can transform or filter a Pub/Sub message.
Protobuf type google.cloud.bigquery.analyticshub.v1.JavaScriptUDF
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > JavaScriptUDFImplements
JavaScriptUDFOrBuilderStatic 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 |
|
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];
| 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:
- (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 | |
|---|---|
| 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> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
toBuilder()
public JavaScriptUDF.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
JavaScriptUDF.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|