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

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Couchbase.Management.Eventing

Assembly: Couchbase.NetClient.dll

Syntax

[JsonConverter(typeof(EventingFunctionConverter))]
public class EventingFunction

Properties

Code

The handler's code.

Declaration

public string Code { get; set; }

Property Value

Type	Description
string

Remarks

Required. The minimum length is 1.

EnforceSchema

Enforces stricter validation for all settings and configuration fields.

Declaration

public bool EnforceSchema { get; set; }

Property Value

Type	Description
bool

FunctionInstanceId

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

Declaration

public string FunctionInstanceId { get; }

Property Value

Type	Description
string

HandlerUuid

Unique id of the the handler. Generated by server.

Declaration

public long HandlerUuid { get; }

Property Value

Type	Description
long

MetaDataKeySpace

Declaration

public EventingFunctionKeyspace MetaDataKeySpace { get; set; }

Property Value

Type	Description
EventingFunctionKeyspace

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.

Settings

Any additional configuration settings.

Declaration

public EventingFunctionSettings Settings { get; set; }

Property Value

Type	Description
EventingFunctionSettings

Remarks

Required.

SourceKeySpace

Declaration

public EventingFunctionKeyspace SourceKeySpace { get; set; }

Property Value

Type	Description
EventingFunctionKeyspace

Version

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

Declaration

public string Version { get; }

Property Value

Type	Description
string

Methods

ToJson()

Declaration

public string ToJson()

Returns

Type	Description
string

ToJson(EventingFunctionKeyspace)

Declaration

public string ToJson(EventingFunctionKeyspace managementScope)

Parameters

Type	Name	Description
EventingFunctionKeyspace	managementScope

Returns

Type	Description
string