Kelvin SDK Client Library Reference

Hierarchy

Index

Methods

Methods

Static createDataType

  • Create Data Type Create Data Type Regex validators: - data type name: `^([a-z][a-z0-9_]+\.)+[a-z][a-z0-9_]+$` - data type class_name: `^[a-zA-Z][a-zA-Z0-9_]+$` Permission Required: `kelvin.permission.data_type.create`

    Parameters

    Returns Observable<DataType>

Static getDataType

  • Get Data Type Get Data Type Permission Required: `kelvin.permission.data_type.read`

    Parameters

    • __namedParameters: { dataTypeName: string; dataTypeVersion: string }
      • dataTypeName: string

        Data Type name

      • dataTypeVersion: string

        Data Type version

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<DataType>

Static getDataTypeDependencies

  • getDataTypeDependencies(__namedParameters: { dataTypeName: string; dataTypeVersion: string }, options?: IKvHttpRequestOptions): Observable<DataType[]>

  • Get Data Type Dependencies Get Data Type Dependencies. This endpoint ill return all dependencies levels in a flattened array. Permission Required: `kelvin.permission.data_type.read`

    Parameters

    • __namedParameters: { dataTypeName: string; dataTypeVersion: string }
      • dataTypeName: string

        Data Type name

      • dataTypeVersion: string

        Data Type version

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<DataType[]>

Static getDataTypeLatestVersion

  • Get Data Type Latest Version Get Data Type Latest Version Permission Required: `kelvin.permission.data_type.read`

    Parameters

    • __namedParameters: { dataTypeName: string }
      • dataTypeName: string

        Data Type name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<DataType>

Static getDataTypeSchema

  • Get Data Type Schema Get Data Type Schema Permission Required: `kelvin.permission.data_type.read`

    Parameters

    • __namedParameters: { dataTypeName: string; dataTypeVersion: string }
      • dataTypeName: string

        Data Type name

      • dataTypeVersion: string

        Data Type version

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<DataTypeSchema>

Static getPaginator

Static listDataType

  • listDataType(__namedParameters?: { all: boolean; connect: boolean; endingBefore: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string }, options?: IKvHttpRequestOptions): Observable<DataTypeListPaginated>

  • List Data Type List Data Type Pagination Sortable Columns: `data_type.name`, `data_type.version` By default returns only the latest versions for each data type Permission Required: `kelvin.permission.data_type.read`

    Parameters

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

        List all versions of all data types. If false, it will only list the latest version. Default: False.

      • connect: boolean

        Only fetch connect data types. Default: False.

      • 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 data types 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<DataTypeListPaginated>

Static onError

Static request

Static requestUrl

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