Class ScopeEventingFunctionManager

ScopeEventingFunctionManager provides an interface for managing the eventing functions on the scope. Uncommitted: This API is subject to change in the future.

Methods

deployFunction dropFunction functionsStatus getAllFunctions getFunction pauseFunction resumeFunction undeployFunction upsertFunction

Methods

deployFunction

  • deployFunction(name, options?, callback?): Promise<void>

  • Deploys an eventing function.

    Parameters

    • name: string

      The name of the eventing function to deploy.

    • Optional options: DeployFunctionOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

dropFunction

  • dropFunction(name, options?, callback?): Promise<void>

  • Deletes an eventing function.

    Parameters

    • name: string

      The name of the eventing function to delete.

    • Optional options: DropFunctionOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

functionsStatus

  • functionsStatus(options?, callback?): Promise<EventingState>

  • Fetches the status of all eventing functions.

    Parameters

    Returns Promise<EventingState>

getAllFunctions

getFunction

  • getFunction(name, options?, callback?): Promise<EventingFunction>

  • Fetches a specific eventing function.

    Parameters

    • name: string

      The name of the eventing function to fetch.

    • Optional options: GetFunctionOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<EventingFunction>

      A node-style callback to be invoked after execution.

    Returns Promise<EventingFunction>

pauseFunction

  • pauseFunction(name, options?, callback?): Promise<void>

  • Pauses an eventing function.

    Parameters

    • name: string

      The name of the eventing function to pause.

    • Optional options: PauseFunctionOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

resumeFunction

  • resumeFunction(name, options?, callback?): Promise<void>

  • Resumes an eventing function.

    Parameters

    • name: string

      The name of the eventing function to resume.

    • Optional options: ResumeFunctionOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

undeployFunction

  • undeployFunction(name, options?, callback?): Promise<void>

  • Undeploys an eventing function.

    Parameters

    • name: string

      The name of the eventing function to undeploy.

    • Optional options: DeployFunctionOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

upsertFunction

  • upsertFunction(functionDefinition, options?, callback?): Promise<void>

  • Creates or updates an eventing function.

    Parameters

    • functionDefinition: EventingFunction

      The description of the eventing function to upsert.

    • Optional options: UpsertFunctionOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

deployFunctiondropFunctionfunctionsStatusgetAllFunctionsgetFunctionpauseFunctionresumeFunctionundeployFunctionupsertFunction