Eventing functions

class acouchbase.management.eventing.EventingFunctionManager(impl: AsyncEventingFunctionMgmtInterface)

Performs management operations on eventing functions.

For managing the eventing functions of a scope, ScopeEventingFunctionManager should be used.

async deploy_function(name: str, options: DeployFunctionOptions | None = None, **kwargs: Unpack[DeployFunctionOptionsKwargs]) → None

Deploys an eventing function.

Parameters:
  • name (str) – The name of the eventing function.

  • options (DeployFunctionOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Raises:
async drop_function(name: str, options: DropFunctionOptions | None = None, **kwargs: Unpack[DropFunctionOptionsKwargs]) → None

Drops an eventing function.

Parameters:
  • name (str) – The name of the eventing function.

  • options (DropFunctionOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Raises:
async functions_status(options: FunctionsStatusOptions | None = None, **kwargs: Unpack[FunctionsStatusOptionsKwargs]) → EventingFunctionsStatus

Returns the status of every eventing function.

Parameters:
  • options (FunctionsStatusOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Returns:

The status of each function.

Return type:

Awaitable[EventingFunctionsStatus]

async get_all_functions(options: GetAllFunctionOptions | None = None, **kwargs: Unpack[GetAllFunctionOptionsKwargs]) → list[EventingFunction]

Returns every eventing function.

Parameters:
  • options (GetAllFunctionOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Returns:

The functions.

Return type:

Awaitable[list[EventingFunction]]

async get_function(name: str, options: GetFunctionOptions | None = None, **kwargs: Unpack[GetFunctionOptionsKwargs]) → EventingFunction

Returns an eventing function.

Parameters:
  • name (str) – The name of the eventing function.

  • options (GetFunctionOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Returns:

The function.

Return type:

Awaitable[EventingFunction]

Raises:

EventingFunctionNotFoundException – If the function does not exist.

async pause_function(name: str, options: PauseFunctionOptions | None = None, **kwargs: Unpack[PauseFunctionOptionsKwargs]) → None

Pauses a deployed eventing function.

Parameters:
  • name (str) – The name of the eventing function.

  • options (PauseFunctionOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Raises:
async resume_function(name: str, options: ResumeFunctionOptions | None = None, **kwargs: Unpack[ResumeFunctionOptionsKwargs]) → None

Resumes a paused eventing function.

Parameters:
  • name (str) – The name of the eventing function.

  • options (ResumeFunctionOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Raises:
async undeploy_function(name: str, options: UndeployFunctionOptions | None = None, **kwargs: Unpack[UndeployFunctionOptionsKwargs]) → None

Undeploys an eventing function.

Parameters:
  • name (str) – The name of the eventing function.

  • options (UndeployFunctionOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Raises:
async upsert_function(function: EventingFunction, options: UpsertFunctionOptions | None = None, **kwargs: Unpack[UpsertFunctionOptionsKwargs]) → None

Creates an eventing function, or replaces one of the same name.

Parameters:
  • function (EventingFunction) – The function to create or replace.

  • options (UpsertFunctionOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Raises:
class acouchbase.management.eventing.ScopeEventingFunctionManager(impl: AsyncEventingFunctionMgmtInterface)

Performs management operations on the eventing functions of a scope.

async deploy_function(name: str, options: DeployFunctionOptions | None = None, **kwargs: Unpack[DeployFunctionOptionsKwargs]) → None

Deploys an eventing function.

Parameters:
  • name (str) – The name of the eventing function.

  • options (DeployFunctionOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Raises:
async drop_function(name: str, options: DropFunctionOptions | None = None, **kwargs: Unpack[DropFunctionOptionsKwargs]) → None

Drops an eventing function.

Parameters:
  • name (str) – The name of the eventing function.

  • options (DropFunctionOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Raises:
async functions_status(options: FunctionsStatusOptions | None = None, **kwargs: Unpack[FunctionsStatusOptionsKwargs]) → EventingFunctionsStatus

Returns the status of every eventing function.

Parameters:
  • options (FunctionsStatusOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Returns:

The status of each function.

Return type:

Awaitable[EventingFunctionsStatus]

async get_all_functions(options: GetAllFunctionOptions | None = None, **kwargs: Unpack[GetAllFunctionOptionsKwargs]) → list[EventingFunction]

Returns every eventing function.

Parameters:
  • options (GetAllFunctionOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Returns:

The functions.

Return type:

Awaitable[list[EventingFunction]]

async get_function(name: str, options: GetFunctionOptions | None = None, **kwargs: Unpack[GetFunctionOptionsKwargs]) → EventingFunction

Returns an eventing function.

Parameters:
  • name (str) – The name of the eventing function.

  • options (GetFunctionOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Returns:

The function.

Return type:

Awaitable[EventingFunction]

Raises:

EventingFunctionNotFoundException – If the function does not exist.

async pause_function(name: str, options: PauseFunctionOptions | None = None, **kwargs: Unpack[PauseFunctionOptionsKwargs]) → None

Pauses a deployed eventing function.

Parameters:
  • name (str) – The name of the eventing function.

  • options (PauseFunctionOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Raises:
async resume_function(name: str, options: ResumeFunctionOptions | None = None, **kwargs: Unpack[ResumeFunctionOptionsKwargs]) → None

Resumes a paused eventing function.

Parameters:
  • name (str) – The name of the eventing function.

  • options (ResumeFunctionOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Raises:
async undeploy_function(name: str, options: UndeployFunctionOptions | None = None, **kwargs: Unpack[UndeployFunctionOptionsKwargs]) → None

Undeploys an eventing function.

Parameters:
  • name (str) – The name of the eventing function.

  • options (UndeployFunctionOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Raises:
async upsert_function(function: EventingFunction, options: UpsertFunctionOptions | None = None, **kwargs: Unpack[UpsertFunctionOptionsKwargs]) → None

Creates an eventing function, or replaces one of the same name.

Parameters:
  • function (EventingFunction) – The function to create or replace.

  • options (UpsertFunctionOptions) – Optional parameters for this operation.

  • **kwargs – keyword arguments that can be used as optional parameters for this operation.

Raises:

This module also publishes these, described where they are first documented: