Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApplicationService

Hierarchy

Index

Constructors

constructor

Methods

binary

clone

create

  • Parameters

    Returns Promise<IResult<IApplication>>

    Response wrapped in IResult

    Example

    
     const newApp = {
       name: 'New application',
       type: 'EXTERNAL',
       key: 'new-app'
     };
    
     (async () => {
       const {data, res} = await applicationService.create(newApp);
     })();
    

delete

  • Parameters

    Returns Promise<IResult<null>>

    Response wrapped in IResult

deleteVersionPackage

  • Parameters

    Returns Object

    Request response.

    Example

    
       const { res } = await applicationService.deleteVersionPackage(app, {version: '1.0.0'});
    
       const { res } = await applicationService.deleteVersionPackage(app, {tag: 'next'});
    
    

detail

  • Parameters

    Returns Promise<IResult<IApplication>>

    Response wrapped in IResult

    Example

    
       const applicationId: number = 1;
    
       (async () => {
         const {data, res} = await applicationService.detail(applicationId);
      })();
    

getAppManifest

  • Parameters

    Returns Promise<IManifest>

    Application manifest object.

getHref

  • Parameters

    Returns string

getInstanceLog

  • Parameters

    Returns Promise<IResult<IApplicationInstanceLog>>

    Response wrapped in IResult

    Example

    
       const applicationId: number = 1;
       const applicationInstanceName: string = 'apama-ctrl-1c-4g-scope-t123456789-deployment-abcdefghij-abcde';
    
       (async () => {
         const {data, res} = await applicationService.getInstanceLog(applicationId, applicationInstanceName);
      })();
    

getInstanceNames

  • Parameters

    Returns string[]

    instance names

    Example

    
       const applicationId: number = 1;
    
       (async () => {
         const {data, res} = await applicationService.getStatusDetails(applicationId);
         const instances = data.map((appMO) => applicationService.getInstanceNames(appMO));
      })();
    

getStatusDetails

  • Parameters

    Returns Promise<IResultList<IApplicationManagedObject>>

    Response wrapped in IResultList

    Example

    
       const applicationId: number = 1;
    
       (async () => {
         const {data, res} = await applicationService.getStatusDetails(applicationId);
      })();
    

isAvailable

  • Parameters

    Returns Promise<IResult<boolean>>

    Response wrapped in IResult

list

listByName

  • Parameters

    • name: string

    Returns Promise<IResultList<IApplication>>

listByOwner

  • Parameters

    • Optional tenantOrName: string | ITenant
    • Default value params: object = {}

    Returns Promise<IResultList<IApplication>>

listByTenant

  • Parameters

    • Optional tenantOrName: string | ITenant
    • Default value params: object = {}

    Returns Promise<IResultList<IApplication>>

listByUser

  • Parameters

    • Optional userOrId: string | number | IUser
    • Default value params: object = {}

    Returns Promise<IResultList<IApplication>>

listVersions

  • Parameters

    • entityOrId: string | number | IApplication
    • Default value params: object = {}

    Returns Promise<IResultList<IApplicationVersion>>

    Returns list of all application versions.

    Example

    
       const applicationId: number = 1;
    
       (async () => {
         const {res, data} = await applicationService.listVersions(applicationId);
      })();
    

reactivateArchive

  • reactivateArchive(appId: number | string): Promise<IResult<null>>
  • Parameters

    • appId: number | string

    Returns Promise<IResult<null>>

setPackageVersionTag

  • setPackageVersionTag(app: IApplication, version: string, tags: string[]): Object
  • Parameters

    Returns Object

    Application version object.

storeAppManifest

  • storeAppManifest(entityOrId: string | number | IApplication, manifestJSON: any): Object
  • Parameters

    • entityOrId: string | number | IApplication
    • manifestJSON: any

    Returns Object

    Application manifest object.

update

  • Parameters

    Returns Promise<IResult<IApplication>>

    Response wrapped in IResult

    Example

    
     const updateApp = {
       id: 38
       name: 'Updated application'
     };
    
     (async () => {
       const {data, res} = await applicationService.update(updateApp);
     })();
    

updateApplicationAvailability

updateApplicationConfig

  • Type parameters

    • T

    Parameters

    Returns Promise<IApplication & object>

    Returns updated configuration.

Generated using TypeDoc