Kelvin SDK Client Library Reference

Hierarchy

Index

Methods

Methods

Static deployWorkload

Static downloadWorkloadPackageFile

  • Download Workload Package File Download Workload Package File Permission Required: `kelvin.permission.workload.read`

    Parameters

    • __namedParameters: { workloadName: string }
      • workloadName: string

        Workload name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<IKvHttpResponse>

Static getPaginator

Static getWorkload

  • Get Workload Get Workload Permission Required: `kelvin.permission.workload.read`

    Parameters

    • __namedParameters: { workloadName: string }
      • workloadName: string

        Workload name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<Workload>

Static getWorkloadLogs

  • Get Workload Logs Get Workload Logs Permission Required: `kelvin.permission.workload.read`

    Parameters

    • __namedParameters: { sinceTime: string; tailLines: string; workloadName: string }
      • sinceTime: string

        A timestamp from which to show logs

      • tailLines: string

        The number of lines from the end of the logs to show

      • workloadName: string

        Workload name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<WorkloadLogs>

Static getWorkloadTelemetry

  • Get Workload Telemetry Get Workload Telemetry Permission Required: `kelvin.permission.workload.read`

    Parameters

    • __namedParameters: { workloadName: string }
      • workloadName: string

        Workload name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<WorkloadTelemetry>

Static listWorkload

  • listWorkload(__namedParameters?: { acpName: string[]; appName: string[]; appVersion: string[]; assetName: string; enabled: boolean; endingBefore: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string; workloadName: string[] }, options?: IKvHttpRequestOptions): Observable<WorkloadListPaginated>

  • List Workload List Workload Pagination Sortable Columns: `workload.name`, `workload.enabled Permission Required: `kelvin.permission.workload.read`

    Parameters

    • Default value __namedParameters: { acpName: string[]; appName: string[]; appVersion: string[]; assetName: string; enabled: boolean; endingBefore: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string; workloadName: string[] } = {}
      • acpName: string[]

        ACP Name

      • appName: string[]

        App Name

      • appVersion: string[]

        App Version

      • assetName: string

        Filter workloads with given asset

      • enabled: boolean

        Filter workloads by enabled status

      • 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 workloads by name, title, App name and ACP name

      • 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

      • workloadName: string[]

        Workload Name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<WorkloadListPaginated>

Static onError

Static request

Static requestUrl

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

Static startWorkload

  • Start Workload Start Workload Permission Required: `kelvin.permission.workload.update`

    Parameters

    • __namedParameters: { workloadName: string }
      • workloadName: string

        Workload name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<IKvHttpResponse>

Static stopWorkload

  • Stop Workload Stop Workload Permission Required: `kelvin.permission.workload.update`

    Parameters

    • __namedParameters: { workloadName: string }
      • workloadName: string

        Workload name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<IKvHttpResponse>

Static undeployWorkload

  • Undeploy Workload Undeploy Workload Permission Required: `kelvin.permission.workload.delete`

    Parameters

    • __namedParameters: { workloadName: string }
      • workloadName: string

        Workload name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<IKvHttpResponse>