Class EventingFunctionManager

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

Index

Methods

deployFunction dropFunction functionsStatus getAllFunctions getFunction pauseFunction resumeFunction undeployFunction upsertFunction

Methods

deployFunction

deployFunction(
    name: string,
    options?: DeployFunctionOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Deploys an eventing function.
Parameters
- name: string
  The name of the eventing function to deploy.
- Optionaloptions: DeployFunctionOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/eventingfunctionmanager.ts:1408

dropFunction

dropFunction(
    name: string,
    options?: DropFunctionOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Deletes an eventing function.
Parameters
- name: string
  The name of the eventing function to delete.
- Optionaloptions: DropFunctionOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/eventingfunctionmanager.ts:1289

functionsStatus

functionsStatus(
options?: FunctionsStatusOptions,
callback?: NodeCallback<EventingState>,
): Promise<EventingState>
Fetches the status of all eventing functions.
Parameters
- Optionaloptions: FunctionsStatusOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<EventingState>
  A node-style callback to be invoked after execution.
Returns Promise<EventingState>
- Defined in lib/eventingfunctionmanager.ts:1563

getAllFunctions

getAllFunctions(
options?: GetAllFunctionsOptions,
callback?: NodeCallback<EventingFunction[]>,
): Promise<EventingFunction[]>
Fetches all eventing functions.
Parameters
- Optionaloptions: GetAllFunctionsOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<EventingFunction[]>
  A node-style callback to be invoked after execution.
Returns Promise<EventingFunction[]>
- Defined in lib/eventingfunctionmanager.ts:1327

getFunction

getFunction(
    name: string,
    options?: GetFunctionOptions,
    callback?: NodeCallback<EventingFunction>,
): Promise<EventingFunction>
Fetches a specific eventing function.
Parameters
- name: string
  The name of the eventing function to fetch.
- Optionaloptions: GetFunctionOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<EventingFunction>
  A node-style callback to be invoked after execution.
Returns Promise<EventingFunction>
- Defined in lib/eventingfunctionmanager.ts:1368

pauseFunction

pauseFunction(
    name: string,
    options?: PauseFunctionOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Pauses an eventing function.
Parameters
- name: string
  The name of the eventing function to pause.
- Optionaloptions: PauseFunctionOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/eventingfunctionmanager.ts:1486

resumeFunction

resumeFunction(
    name: string,
    options?: ResumeFunctionOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Resumes an eventing function.
Parameters
- name: string
  The name of the eventing function to resume.
- Optionaloptions: ResumeFunctionOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/eventingfunctionmanager.ts:1525

undeployFunction

undeployFunction(
    name: string,
    options?: DeployFunctionOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Undeploys an eventing function.
Parameters
- name: string
  The name of the eventing function to undeploy.
- Optionaloptions: DeployFunctionOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/eventingfunctionmanager.ts:1447

upsertFunction

upsertFunction(
    functionDefinition: EventingFunction,
    options?: UpsertFunctionOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Creates or updates an eventing function.
Parameters
- functionDefinition: EventingFunction
  The description of the eventing function to upsert.
- Optionaloptions: UpsertFunctionOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/eventingfunctionmanager.ts:1250

Class EventingFunctionManager

Index

Methods

Methods

deployFunction

Parameters

Returns Promise<void>

dropFunction

Parameters

Returns Promise<void>

functionsStatus

Parameters

Returns Promise<EventingState>

getAllFunctions

Parameters

Returns Promise<EventingFunction[]>

getFunction

Parameters

Returns Promise<EventingFunction>

pauseFunction

Parameters

Returns Promise<void>

resumeFunction

Parameters

Returns Promise<void>

undeployFunction

Parameters

Returns Promise<void>

upsertFunction

Parameters

Returns Promise<void>

Settings

On This Page