Package com.couchbase.client.java.manager.eventing

Class EventingFunction

java.lang.Object

com.couchbase.client.java.manager.eventing.EventingFunction

@Uncommitted
public class EventingFunction
extends Object

An immutable representation of the EventingFunction stored or to be stored on the server.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventingFunction.Builder	This builder allows to customize the properties of the eventing function.

Method Summary

Modifier and Type	Method	Description
List<EventingFunctionBucketBinding>	bucketBindings()	The bucket bindings for the function.
static EventingFunction.Builder	builder(String name, String code, EventingFunctionKeyspace sourceKeyspace, EventingFunctionKeyspace metadataKeyspace)	Creates a EventingFunction.Builder that can be used to further customize the EventingFunction beyond the defaults.
String	code()	The actual javascript source code of the function.
List<EventingFunctionConstantBinding>	constantBindings()	The constant bindings for the function.
static EventingFunction	create(String name, String code, EventingFunctionKeyspace sourceKeyspace, EventingFunctionKeyspace metadataKeyspace)	Creates a new EventingFunction with the minimal required properties.
boolean	enforceSchema()	True if the schema should be enforced.
static List<EventingFunction>	fromExportedFunctions(byte[] encoded)	Creates a list of EventingFunctions from a raw JSON, usually exported from the server UI.
static EventingFunction	fromFunction(byte[] encoded)	Creates a EventingFunction from a raw JSON.
String	functionInstanceId()	The function instance ID, provided by the server.
long	handlerUuid()	The function UUID, provided by the server.
EventingFunctionKeyspace	metadataKeyspace()	The keyspace where eventing stores the metadata for the function.
String	name()	The name of the function.
EventingFunctionSettings	settings()	The custom function settings applied.
EventingFunctionKeyspace	sourceKeyspace()	The source keyspace where the actual data is accessed from.
String	toString()
List<EventingFunctionUrlBinding>	urlBindings()	The URL bindings for the function.
String	version()	The version of the function.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

create

public static EventingFunction create(String name,
                                      String code,
                                      EventingFunctionKeyspace sourceKeyspace,
                                      EventingFunctionKeyspace metadataKeyspace)

Creates a new EventingFunction with the minimal required properties.

Parameters:

name - the name of the function.

code - the code body of the function.

sourceKeyspace - the keyspace from where the source data is coming from.

metadataKeyspace - the keyspace where the function metadata is stored.

Returns:

the created EventingFunction.

builder

public static EventingFunction.Builder builder(String name,
                                               String code,
                                               EventingFunctionKeyspace sourceKeyspace,
                                               EventingFunctionKeyspace metadataKeyspace)

Creates a EventingFunction.Builder that can be used to further customize the EventingFunction beyond the defaults.

Parameters:

name - the name of the function.

code - the code body of the function.

sourceKeyspace - the keyspace from where the source data is coming from.

metadataKeyspace - the keyspace where the function metadata is stored.

Returns:

the builder to customize.

fromFunction

@Volatile
public static EventingFunction fromFunction(byte[] encoded)

Creates a EventingFunction from a raw JSON.

Note that the server exports it as a JSON array, so you might want to consider using fromExportedFunctions(byte[]) for those.

Parameters:

encoded - the encoded function to load.

Returns:

the created EventingFunction.

fromExportedFunctions

@Volatile
public static List<EventingFunction> fromExportedFunctions(byte[] encoded)

Creates a list of EventingFunctions from a raw JSON, usually exported from the server UI.

Parameters:

encoded - the encoded functions to load.

Returns:

the created list of EventingFunctions.

name

public String name()

The name of the function.

code

public String code()

The actual javascript source code of the function.

sourceKeyspace

public EventingFunctionKeyspace sourceKeyspace()

The source keyspace where the actual data is accessed from.

metadataKeyspace

public EventingFunctionKeyspace metadataKeyspace()

The keyspace where eventing stores the metadata for the function.

version

public String version()

The version of the function.

enforceSchema

public boolean enforceSchema()

True if the schema should be enforced.

handlerUuid

public long handlerUuid()

The function UUID, provided by the server.

functionInstanceId

public String functionInstanceId()

The function instance ID, provided by the server.

settings

public EventingFunctionSettings settings()

The custom function settings applied.

bucketBindings

public List<EventingFunctionBucketBinding> bucketBindings()

The bucket bindings for the function.

urlBindings

public List<EventingFunctionUrlBinding> urlBindings()

The URL bindings for the function.

constantBindings

public List<EventingFunctionConstantBinding> constantBindings()

The constant bindings for the function.

toString

public String toString()

Overrides:

toString in class Object