Kelvin SDK Client Library Reference

Hierarchy

Index

Methods

Methods

Static createApp

  • Create App Create App Note: If the App already exists, the App Version will be appended to the existing App Permission Required: `kelvin.permission.appregistry.create`

    Parameters

    Returns Observable<App>

Static deleteApp

  • Delete App Delete App Note: Deleting an App will also delete all App Versions Permission Required: `kelvin.permission.appregistry.delete`

    Parameters

    • __namedParameters: { appName: string }
      • appName: string

        App name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<IKvHttpResponse>

Static deleteAppVersion

  • Delete App Version Delete App Version Note: This operation also deletes the associated Docker Image Permission Required: `kelvin.permission.appregistry.delete`

    Parameters

    • __namedParameters: { appName: string; appVersion: string }
      • appName: string

        App name

      • appVersion: string

        App Version

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<IKvHttpResponse>

Static getApp

  • Get App Get App Permission Required: `kelvin.permission.appregistry.read`

    Parameters

    • __namedParameters: { appName: string }
      • appName: string

        App name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<App>

Static getAppVersion

  • Get App Version Get App Version Permission Required: `kelvin.permission.appregistry.read`

    Parameters

    • __namedParameters: { appName: string; appVersion: string }
      • appName: string

        App name

      • appVersion: string

        App Version

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<AppVersion>

Static getPaginator

Static listApps

  • listApps(__namedParameters?: { endingBefore: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string; type: string[] }, options?: IKvHttpRequestOptions): Observable<AppListPaginated>

  • List Apps List Apps Pagination Sortable Columns: `app.name`, `app.title`, `app.type`, `app.latest_version`, `app.created`, `app.updated`, `status` Permission Required: `kelvin.permission.appregistry.read`

    Parameters

    • Default value __namedParameters: { endingBefore: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string; type: string[] } = {}
      • endingBefore: string

        Upper bound cursor for use in pagination

      • pageSize: number

        Number of objects to be returned, between 1 and 1000. Default: 20

      • search: string[]

        Search Apps by name and title

      • sortAsc: boolean

        Order of sorting is Ascending. Possible Values: true/false. Default: true

      • sortBy: string

        Parameter to sort by. Must be one of the sortable columns

      • startingAfter: string

        Lower bound cursor for use in pagination

      • type: string[]

        Match the type field

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<AppListPaginated>

Static onError

Static request

Static requestUrl

  • requestUrl<T>(request: IKvHttpRequest, modelClass?: IModel, autenticated?: boolean): Observable<T>

Static updateApp

  • Update App Update App Permission Required: `kelvin.permission.appregistry.update`

    Parameters

    Returns Observable<App>