Interface IEventingFunctionManager

The manager allows the user to read functions, modify them and change their deployment state.

Namespace: Couchbase.Management.Eventing
Assembly: Couchbase.NetClient.dll
Syntax
[InterfaceStability(Level.Uncommitted)]
public interface IEventingFunctionManager

Methods

| Edit this page View Source

DeployFunctionAsync(string, DeployFunctionOptions?)

Deploys a function (from state undeployed to deployed).

Declaration
Task DeployFunctionAsync(string name, DeployFunctionOptions? options = null)
Parameters
Type Name Description
string name

The function name.
DeployFunctionOptions options

Any optional parameters.
Returns
Type Description
Task

A Task for awaiting.
| Edit this page View Source

DropFunctionAsync(string, DropFunctionOptions?)

Drops a function.

Declaration
Task DropFunctionAsync(string name, DropFunctionOptions? options = null)
Parameters
Type Name Description
string name

The function name.
DropFunctionOptions options

Any optional parameters.
Returns
Type Description
Task

A Task for awaiting.
| Edit this page View Source

FunctionsStatus(FunctionsStatusOptions?)

Receives the status of all the eventing functions.

Declaration
Task<EventingStatus> FunctionsStatus(FunctionsStatusOptions? options = null)
Parameters
Type Name Description
FunctionsStatusOptions options

Any optional parameters.
Returns
Type Description
Task<EventingStatus>
| Edit this page View Source

GetAllFunctionsAsync(GetAllFunctionOptions?)

Lists all functions (both deployed and undeployed).

Declaration
Task<IEnumerable<EventingFunction>> GetAllFunctionsAsync(GetAllFunctionOptions? options = null)
Parameters
Type Name Description
GetAllFunctionOptions options

Any optional parameters.
Returns
Type Description
Task<IEnumerable<EventingFunction>>

An IEnumerable<T> for enumeration of the results.
| Edit this page View Source

GetFunctionAsync(string, GetFunctionOptions?)

Fetches a specific function.

Declaration
Task<EventingFunction?> GetFunctionAsync(string name, GetFunctionOptions? options = null)
Parameters
Type Name Description
string name

The function name.
GetFunctionOptions options

Any optional parameters.
Returns
Type Description
Task<EventingFunction>
| Edit this page View Source

PauseFunctionAsync(string, PauseFunctionOptions?)

Pauses a function.

Declaration
Task PauseFunctionAsync(string name, PauseFunctionOptions? options = null)
Parameters
Type Name Description
string name

The function name.
PauseFunctionOptions options

Any optional parameters.
Returns
Type Description
Task

A Task for awaiting.
| Edit this page View Source

ResumeFunctionAsync(string, ResumeFunctionOptions?)

Resumes a function if it is paused.

Declaration
Task ResumeFunctionAsync(string name, ResumeFunctionOptions? options = null)
Parameters
Type Name Description
string name

The function name.
ResumeFunctionOptions options

Any optional parameters.
Returns
Type Description
Task

A Task for awaiting.
| Edit this page View Source

UndeployFunctionAsync(string, UndeployFunctionOptions?)

Undeploys a function (from state deployed to undeployed).

Declaration
Task UndeployFunctionAsync(string name, UndeployFunctionOptions? options = null)
Parameters
Type Name Description
string name

The function name.
UndeployFunctionOptions options

Any optional parameters.
Returns
Type Description
Task

A Task for awaiting.
| Edit this page View Source

UpsertFunctionAsync(EventingFunction, UpsertFunctionOptions?)

Declaration
Task UpsertFunctionAsync(EventingFunction function, UpsertFunctionOptions? options = null)
Parameters
Type Name Description
EventingFunction function
UpsertFunctionOptions options
Returns
Type Description
Task