Class EventingFunctionSettings

Advanced settings that may be adjusted.

Inheritance

object

EventingFunctionSettings

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(EventingFunctionSettingsConverter))]
public class EventingFunctionSettings

Properties

| Edit this page View Source

AppLogDir

Directory to write content of log() message files.

Declaration

public string AppLogDir { get; set; }

Property Value

Type	Description
string

| Edit this page View Source

AppLogMaxFiles

Number of log() message files to retain when rotating.

Declaration

public int AppLogMaxFiles { get; set; }

Property Value

Type	Description
int

Remarks

The minimum is 1 and the default is 10.

| Edit this page View Source

AppLogMaxSize

Rotate logs when file grows to this size in bytes approximately.

Declaration

public int AppLogMaxSize { get; set; }

Property Value

Type	Description
int

Remarks

The minimum is 1024b and the max is 41943040b.

| Edit this page View Source

BucketCacheAge

Time in milliseconds after which a cached bucket object is considered stale.

Declaration

public int BucketCacheAge { get; set; }

Property Value

Type	Description
int

Remarks

The minimum is 1 and the default is 1000.

| Edit this page View Source

BucketCacheSize

Maximum size in bytes the bucket cache can grow to.

Declaration

public int BucketCacheSize { get; set; }

Property Value

Type	Description
int

Remarks

The minimum is 20971520 and the default is 67108864.

| Edit this page View Source

CheckpointInterval

Number of seconds before writing a progress checkpoint.

Declaration

public int CheckpointInterval { get; set; }

Property Value

Type	Description
int

Remarks

The minimum is 1 and the default is 60.

| Edit this page View Source

CppWorkerThreadCount

Number of threads each worker utilizes.

Declaration

public int CppWorkerThreadCount { get; set; }

Property Value

Type	Description
int

Remarks

Minimum is 1.

| Edit this page View Source

CurlMaxAllowedRespSize

Maximum allowable curl call response in 'MegaBytes'. Setting the value to 0 lifts the upper limit off. This parameters affects v8 engine stability since it defines the maximum amount of heap space acquired by a curl call

Declaration

public int CurlMaxAllowedRespSize { get; set; }

Property Value

Type	Description
int

Remarks

The default is 100mb.

| Edit this page View Source

DcpStreamBoundary

Indicates where to start dcp stream from (beginning of time, present point) 'from_prior' is deprecated in 6.6.2.

Declaration

public EventingFunctionDcpBoundary DcpStreamBoundary { get; set; }

Property Value

Type	Description
EventingFunctionDcpBoundary

| Edit this page View Source

DeploymentStatus

Indicates if the function is deployed. true=deployed, false=undeployed.

Declaration

public EventingFunctionDeploymentStatus DeploymentStatus { get; set; }

Property Value

Type	Description
EventingFunctionDeploymentStatus

| Edit this page View Source

Description

Free form text for user to describe the handler. no functional role.

Declaration

public string Description { get; set; }

Property Value

Type	Description
string

| Edit this page View Source

EnableAppLogRotation

Enable rotating this handlers log() message files.

Declaration

public bool EnableAppLogRotation { get; set; }

Property Value

Type	Description
bool

| Edit this page View Source

ExecutionTimeout

Maximum time the handler can run before it is forcefully terminated (in seconds).

Declaration

public TimeSpan ExecutionTimeout { get; set; }

Property Value

Type	Description
TimeSpan

Remarks

The minimum is 1 and the default is 60s.

| Edit this page View Source

HandlerFooters

Code to automatically append to bottom of handler code.

Declaration

public List<string> HandlerFooters { get; set; }

Property Value

Type	Description
List<string>

| Edit this page View Source

HandlerHeaders

Code to automatically prepend to top of handler code.

Declaration

public List<string> HandlerHeaders { get; set; }

Property Value

Type	Description
List<string>

| Edit this page View Source

LanguageCompatibility

Eventing language version this handler assumes in terms of syntax and behavior.

Declaration

public EventingFunctionLanguageCompatibility LanguageCompatibility { get; set; }

Property Value

Type	Description
EventingFunctionLanguageCompatibility

Remarks

Default is '6.6.2'.

| Edit this page View Source

LcbInstCapacity

Maximum number of libcouchbase connections that may be opened and pooled.

Declaration

public int LcbInstCapacity { get; set; }

Property Value

Type	Description
int

Remarks

The minimum is 1 and the default is 10.

| Edit this page View Source

LcbTimeout

Maximum time the lcb command is waited until completion before we terminate the request(in seconds).

Declaration

public TimeSpan LcbTimeout { get; set; }

Property Value

Type	Description
TimeSpan

Remarks

The minimum is 1 and the default is 5.

| Edit this page View Source

LogLevel

Level of detail in system logging.

Declaration

public EventingFunctionLogLevel LogLevel { get; set; }

Property Value

Type	Description
EventingFunctionLogLevel

Remarks

Default is INFO.

| Edit this page View Source

NumTimerPartitions

Number of timer shards. defaults to number of vbuckets.

Declaration

public int NumTimerPartitions { get; set; }

Property Value

Type	Description
int

Remarks

1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024

| Edit this page View Source

ProcessingStatus

Indicates if the function is running (i.e., not paused). true=running, false=paused.

Declaration

public EventingFunctionProcessingStatus ProcessingStatus { get; set; }

Property Value

Type	Description
EventingFunctionProcessingStatus

| Edit this page View Source

QueryConsistency

Consistency level used by n1ql statements in the handler.

Declaration

public QueryScanConsistency QueryConsistency { get; set; }

Property Value

Type	Description
QueryScanConsistency

Remarks

The default is 'none' or 'not bounded'.

| Edit this page View Source

QueryPrepareAll

Automatically prepare all n1ql statements in the handler.

Declaration

public bool QueryPrepareAll { get; set; }

Property Value

Type	Description
bool

Remarks

The default is false.

| Edit this page View Source

SockBatchSize

Batch size for messages from producer to consumer. normally, this must not be specified.

Declaration

public int SockBatchSize { get; set; }

Property Value

Type	Description
int

Remarks

Default is 1.

| Edit this page View Source

TickDuration

Duration to log stats from this handler, in milliseconds.

Declaration

public int TickDuration { get; set; }

Property Value

Type	Description
int

Remarks

The default is 60000ms.

| Edit this page View Source

TimerContextSize

Size limit of timer context object

Declaration

public int TimerContextSize { get; set; }

Property Value

Type	Description
int

Remarks

The minimum is 20, the max is 20971520 and the default is 1024.

| Edit this page View Source

UserPrefix

Key prefix for all data stored in metadata by this handler.

Declaration

public string UserPrefix { get; set; }

Property Value

Type	Description
string

Remarks

The default is 'eventing'.

| Edit this page View Source

WorkerCount

Number of worker processes handler utilizes on each eventing node.

Declaration

public int WorkerCount { get; set; }

Property Value

Type	Description
int

Remarks

The minimum is 1 and the default is 1.