Kelvin SDK Client Library Reference

Hierarchy

Index

Methods

Methods

Static createRule

Static deleteRule

  • Delete Rule Delete Rule Permission Required: `kelvin.permission.rule.delete`

    Parameters

    • __namedParameters: { ruleName: string }
      • ruleName: string

        Rule name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<IKvHttpResponse>

Static getLogsRule

  • getLogsRule(__namedParameters: { ruleName: string; sinceTime: string; tailLines: string }, options?: IKvHttpRequestOptions): Observable<RuleLogs>

  • Get Logs Rule Get Logs Rule Permission Required: `kelvin.permission.rule.read`

    Parameters

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

        Rule name

      • sinceTime: string

        A timestamp from which to show logs

      • tailLines: string

        The number of lines from the end of the logs to show. Default: 500

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<RuleLogs>

Static getPaginator

Static getRule

  • Get Rule Get Rule Permission Required: `kelvin.permission.rule.read`

    Parameters

    • __namedParameters: { ruleName: string }
      • ruleName: string

        Rule name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<Rule>

Static listRules

  • listRules(__namedParameters?: { endingBefore: string; mapNames: string[]; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string; states: string[]; target: string }, options?: IKvHttpRequestOptions): Observable<RulesListPaginated>

  • List Rules List Rules Pagination Sortable Columns: `rule.name`, `rule.title`, `rule.map_name`, `rule.target`, `rule.state`, `rule.enabled`, `rule.created`, `rule.updated` Permission Required: `kelvin.permission.rule.read`

    Parameters

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

        Upper bound cursor for use in pagination

      • mapNames: string[]

        Search rules by map name

      • pageSize: number

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

      • search: string[]

        Search rules by name or 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

      • states: string[]

        Search rules by state

      • target: string

        Search rules by target

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<RulesListPaginated>

Static onError

Static request

Static requestUrl

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

Static updateRule

  • Update Rule Update Rule Permission Required: `kelvin.permission.rule.update`

    Parameters

    Returns Observable<Rule>