Kelvin SDK Client Library Reference

Hierarchy

Index

Methods

Methods

Static createACPMetadata

Static createACPMetadataBulk

Static deleteACP

  • Delete ACP Delete ACP Permission Required: `kelvin.permission.acp.delete`

    Parameters

    • __namedParameters: { acpName: string }
      • acpName: string

        ACP name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<IKvHttpResponse>

Static deleteACPMetadata

  • Delete ACP Metadata Delete ACP Metadata Permission Required: `kelvin.permission.acp.delete`

    Parameters

    • __namedParameters: { acpMetadataName: string; acpName: string }
      • acpMetadataName: string

        ACP Metadata name

      • acpName: string

        ACP name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<IKvHttpResponse>

Static deleteACPMetadataBulk

Static forceUpdateACPEdgeAppVersion

  • Force Update ACP Edge App Version Force Update ACP Edge App Version Permission Required: `kelvin.permission.acp.read`

    Parameters

    • __namedParameters: { acpName: string }
      • acpName: string

        ACP name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<IKvHttpResponse>

Static getACP

  • Get ACP Get ACP Permission Required: `kelvin.permission.acp.read`

    Parameters

    • __namedParameters: { acpName: string; metadata: string[] }
      • acpName: string

        ACP name

      • metadata: string[]

        Inject metadata into the response

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<ACP>

Static getACPEdgeAppVersion

  • Get ACP Edge App Version Get ACP Edge App Version Permission Required: `kelvin.permission.acp.read`

    Parameters

    • __namedParameters: { acpName: string }
      • acpName: string

        ACP name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<ACPEdgeAppVersion>

Static getACPMetadata

  • Get ACP Metadata Get ACP Metadata Permission Required: `kelvin.permission.acp.read`

    Parameters

    • __namedParameters: { acpMetadataName: string; acpName: string }
      • acpMetadataName: string

        ACP Metadata name

      • acpName: string

        ACP name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<ACPMetadata>

Static getACPStatusCount

  • Get ACP Status Count Get ACP Status Count Permission Required: `kelvin.permission.acp.read`

    Parameters

    Returns Observable<ACPStatusCount>

Static getACPTelemetry

  • Get ACP Telemetry Get ACP Telemetry Permission Required: `kelvin.permission.acp.read`

    Parameters

    • __namedParameters: { acpName: string }
      • acpName: string

        ACP name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<ACPTelemetry>

Static getPaginator

Static getWorkloadsManifests

  • Get Workloads Manifests Get Workloads Manifests assigned to an ACP Permission Required: `kelvin.permission.acp.read`

    Parameters

    • __namedParameters: { acpName: string }
      • acpName: string

        ACP name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<ACPWorkloadManifests>

Static listACP

  • listACP(__namedParameters?: { connected: boolean; endingBefore: string; metadata: string[]; metadataFilter: string[]; names: string[]; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string }, options?: IKvHttpRequestOptions): Observable<ACPListPaginated>

  • List ACP List ACP Pagination Sortable Columns: `acp.name`, `acp.title`, `acp.created`, `acp.updated`, `status_state`, `status_last_seen` Permission Required: `kelvin.permission.acp.read`

    Parameters

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

        Filter by connected ACPs. Possible Values: true/false. Default: none

      • endingBefore: string

        Upper bound cursor for use in pagination

      • metadata: string[]

        Inject metadata into the response

      • metadataFilter: string[]

        Dot separated string to filter by metadata values

      • names: string[]

        Filter ACPs by name

      • pageSize: number

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

      • search: string[]

        Search ACP 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<ACPListPaginated>

Static listACPMetadata

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

  • List ACP Metadata List ACP Metadata Pagination Sortable Columns: `acp_metadata.name`, `acp_metadata.acp_name` Permission Required: `kelvin.permission.acp.read`

    Parameters

    • __namedParameters: { acpName: string; endingBefore: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string }
      • acpName: string

        ACP name

      • 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 ACP Metadata 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<ACPMetadataListPaginated>

Static onError

Static request

Static requestUrl

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

Static updateACP

  • Update ACP Update ACP Permission Required: `kelvin.permission.acp.update`

    Parameters

    Returns Observable<ACP>

Static updateACPMetadata

  • Update ACP Metadata Update ACP Metadata Permission Required: `kelvin.permission.acp.update`

    Parameters

    Returns Observable<ACPMetadata>

Static updateACPStatus