Kelvin SDK Client Library Reference

Hierarchy

Index

Methods

Methods

Static deleteInstanceSetting

  • Delete Instance Setting Delete Instance Setting Permission Required: `kelvin.permission.instance.delete`

    Parameters

    • __namedParameters: { settingName: string }
      • settingName: string

        Setting Name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<IKvHttpResponse>

Static getAuditLog

  • Get Audit Log Get Audit Log Permission Required: `kelvin.permission.audit_log.read`

    Parameters

    • __namedParameters: { auditLoggerId: string }
      • auditLoggerId: string

        Audit Logger ID

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<AuditLogger>

Static getInstanceHealthStatus

Static getInstanceSetting

  • Get Instance Setting Get Instance Setting Permission Required: `kelvin.permission.instance.read`

    Parameters

    • __namedParameters: { settingName: string }
      • settingName: string

        Setting Name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<InstanceSettingItem>

Static getKelvinACPInstanceSetting

  • Get Kelvin ACP Instance Setting Get Kelvin ACP Instance Setting Permission Required: `kelvin.permission.instance.read`

    Parameters

    Returns Observable<InstanceSettingItem>

Static getKelvinCarbonEmissionsInstanceSetting

  • Get Kelvin Carbon Emissions Instance Setting Get Kelvin Carbon Emissions Instance Setting Permission Required: `kelvin.permission.instance.read`

    Parameters

    Returns Observable<CarbonEmissionsInstanceSettingItem>

Static getPaginator

Static listAuditLog

  • listAuditLog(__namedParameters?: { action: string[]; endingBefore: string; fromDateTime: Date; identifier: string[]; namespace: string[]; pageSize: number; requestId: string[]; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string; toDateTime: Date; userId: string[]; username: string[] }, options?: IKvHttpRequestOptions): Observable<AuditLoggerListPaginated>

  • List Audit Log List Audit Log Pagination Sortable Columns: `audit_log.id`, `audit_log.action`, `audit_log.username`, `audit_log.created`, `request_uri` Note: Both `from_date_time` and `to_date_time` support RFC3339 format with microseconds Permission Required: `kelvin.permission.audit_log.read`

    Parameters

    • Default value __namedParameters: { action: string[]; endingBefore: string; fromDateTime: Date; identifier: string[]; namespace: string[]; pageSize: number; requestId: string[]; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string; toDateTime: Date; userId: string[]; username: string[] } = {}
      • action: string[]

        Filter by action

      • endingBefore: string

        Upper bound cursor for use in pagination

      • fromDateTime: Date

        Filter actions occurred at or after this date-time

      • identifier: string[]

        Filter by identifier

      • namespace: string[]

        Filter by namespace

      • pageSize: number

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

      • requestId: string[]

        Filter by request_id

      • search: string[]

        Search Audit Log by action, username or namespace

      • sortAsc: boolean

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

      • sortBy: string

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

      • startingAfter: string

        Lower bound cursor for use in pagination

      • toDateTime: Date

        Filter actions occurred until or at this date-time

      • userId: string[]

        Filter by user_id

      • username: string[]

        Filter by username

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<AuditLoggerListPaginated>

Static listInstanceSettings

  • List Instance Settings List Instance Settings Pagination Sortable Columns: `instance_setting.name, instance_setting.created, instance_setting.updated` Permission Required: `kelvin.permission.instance.read`

    Parameters

    • Default value __namedParameters: { endingBefore: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: 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 Instance Setting by 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

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<InstanceSettingListPaginated>

Static onError

Static request

Static requestUrl

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

Static updateInstanceSetting

Static updateKelvinACPInstanceSetting

Static updateKelvinCarbonEmissionsInstanceSetting