Kelvin SDK Client Library Reference

Hierarchy

Index

Methods

Methods

Static getFailureClass

  • Get Failure Class Get Failure Class Permission Required: `kelvin.permission.failure_detection.read`

    Parameters

    • __namedParameters: { failureClassName: string }
      • failureClassName: string

        Failure Class Name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<FailureClass>

Static getPaginator

Static listAnalysis

  • List Analysis List Analysis Permission Required: `kelvin.permission.failure_detection.read`

    Parameters

    • Default value __namedParameters: { semanticTypeName: string } = {}
      • semanticTypeName: string

        Filter analysis by semantic_type_name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<FailureAnalysisList>

Static listFailureClasses

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

  • List Failure Classes List Failure Classes Pagination Sortable Columns: `fd_failure_class.name`, `fd_failure_class.title`, `fd_failure_class.device_type_name`, `fd_failure_class.created`, `fd_failure_class.updated` Permission Required: `kelvin.permission.failure_detection.read`

    Parameters

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

        Upper bound cursor for use in pagination

      • entityTypeName: string

        Filter failure classes by entity type name

      • pageSize: number

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

      • search: string[]

        Search failure classes 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

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<FailureClassPaginated>

Static listFailureEvents

  • listFailureEvents(__namedParameters?: { alarmCustomIdentifier: string[]; alarmId: string[]; endingBefore: string; id: string[]; pageSize: number; sortAsc: boolean; sortBy: string; startingAfter: string; status: string[]; targetAssetName: string[]; traceId: string[] }, options?: IKvHttpRequestOptions): Observable<FailureEventPaginated>

  • List Failure Events List Failure Events Pagination Sortable Columns: `fd_events.id`, `fd_events.trace_id`, `fd_events.status`, `fd_events.target_asset_name`, `fd_events.alarm_id`, `fd_events.alarm_custom_identifier`, `fd_events.created`, `fd_events.updated` Permission Required: `kelvin.permission.failure_detection.read`

    Parameters

    • Default value __namedParameters: { alarmCustomIdentifier: string[]; alarmId: string[]; endingBefore: string; id: string[]; pageSize: number; sortAsc: boolean; sortBy: string; startingAfter: string; status: string[]; targetAssetName: string[]; traceId: string[] } = {}
      • alarmCustomIdentifier: string[]

        Filter failure events by alarm custom identifier

      • alarmId: string[]

        Filter failure events by target alarm id

      • endingBefore: string

        Upper bound cursor for use in pagination

      • id: string[]

        Filter failure events by id

      • pageSize: number

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

      • 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

      • status: string[]

        Filter failure events by status

      • targetAssetName: string[]

        Filter failure events by target asset name

      • traceId: string[]

        Filter failure events by trace id

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<FailureEventPaginated>

Static listFailureModes

  • listFailureModes(__namedParameters?: { componentFailureClassName: string; partFailureClassName: string }, options?: IKvHttpRequestOptions): Observable<FailureList>

  • List Failure Modes List Failure Modes Permission Required: `kelvin.permission.failure_detection.read`

    Parameters

    • Default value __namedParameters: { componentFailureClassName: string; partFailureClassName: string } = {}
      • componentFailureClassName: string

        Filter failures by component failure class name

      • partFailureClassName: string

        Filter failures by part failure class name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<FailureList>

Static listFailureReasons

  • listFailureReasons(__namedParameters?: { componentFailureClassName: string; partFailureClassName: string }, options?: IKvHttpRequestOptions): Observable<FailureList>

  • List Failure Reasons List Failure Reasons Permission Required: `kelvin.permission.failure_detection.read`

    Parameters

    • Default value __namedParameters: { componentFailureClassName: string; partFailureClassName: string } = {}
      • componentFailureClassName: string

        Filter failures by component failure class name

      • partFailureClassName: string

        Filter failures by part failure class name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<FailureList>

Static listFailures

  • List Failures List Failures Permission Required: `kelvin.permission.failure_detection.read`

    Parameters

    • __namedParameters: { assetClass: string; sourceComponentClass: string[] }
      • assetClass: string

        Filter failures by asset class

      • sourceComponentClass: string[]

        Filter failures by source component class name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<AssetClassFailureList>

Static listThresholds

  • List Thresholds List Thresholds Permission Required: `kelvin.permission.failure_detection.read`

    Parameters

    • Default value __namedParameters: { componentClassNames: string[] } = {}
      • componentClassNames: string[]

        Filter Thresholds by component_class_name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<FailureAnalysisThresholdsList>

Static onError

Static request

Static requestUrl

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

Static updateThresholds