Class EventingFunction

Eventing Functions offers a computing paradigm using which developers can handle data changes via the handlers of OnUpdate or OnDelete. Resources are managed at or above the Eventing Function level, and the containing Eventing Function scopes the state of all handlers.

Inheritance
object
EventingFunction
Inherited Members
Namespace: Couchbase.Management.Eventing
Assembly: Couchbase.NetClient.dll
Syntax
[JsonConverter(typeof(EventingFunctionConverter))]
public class EventingFunction

Constructors

View Source

EventingFunction()

Declaration
public EventingFunction()

Properties

View Source

Code

The handler's code.

Declaration
public string Code { get; set; }
Property Value
Type Description
string
Remarks

Required. The minimum length is 1.

View Source

EnforceSchema

Enforces stricter validation for all settings and configuration fields.

Declaration
public bool EnforceSchema { get; set; }
Property Value
Type Description
bool
View Source

FunctionInstanceId

Unique id of the deployment of the handler. Generated by server.

Declaration
public string FunctionInstanceId { get; }
Property Value
Type Description
string
View Source

HandlerUuid

Unique id of the the handler. Generated by server.

Declaration
public long HandlerUuid { get; }
Property Value
Type Description
long
View Source

MetaDataKeySpace

Declaration
public EventingFunctionKeyspace MetaDataKeySpace { get; set; }
Property Value
Type Description
EventingFunctionKeyspace
View Source

Name

The app name.

Declaration
public string Name { get; set; }
Property Value
Type Description
string
Remarks

Required. The minimum length is 1 and the max length is 100.

View Source

Settings

Any additional configuration settings.

Declaration
public EventingFunctionSettings Settings { get; set; }
Property Value
Type Description
EventingFunctionSettings
Remarks

Required.

View Source

SourceKeySpace

Declaration
public EventingFunctionKeyspace SourceKeySpace { get; set; }
Property Value
Type Description
EventingFunctionKeyspace
View Source

Version

Authoring tool. use 'external' if authored or edited outside eventing ui.

Declaration
public string Version { get; }
Property Value
Type Description
string

Methods

View Source

ToJson()

Declaration
public string ToJson()
Returns
Type Description
string
View Source

ToJson(EventingFunctionKeyspace)

Declaration
public string ToJson(EventingFunctionKeyspace managementScope)
Parameters
Type Name Description
EventingFunctionKeyspace managementScope
Returns
Type Description
string