@bitmovin/api-sdk/dist/encoding/live/streamKeys/StreamKeyListQueryParams.d.ts

Bitmovin JS/TS API SDK

export interface StreamKeyListQueryParams {
    /**
     * Index of the first item to return, starting at 0. Default is 0
     * @type {number}
     * @memberof StreamKeyListQueryParams
     */
    offset?: number | undefined;
    /**
     * Maximum number of items to return. Default is 25, maximum is 100
     * @type {number}
     * @memberof StreamKeyListQueryParams
     */
    limit?: number | undefined;
    /**
     * Order list result according a stream key attribute.  The fields that can be used for sorting are: + `createdAt` + `name`
     * @type {string}
     * @memberof StreamKeyListQueryParams
     */
    sort?: string | undefined;
    /**
     * Filter stream keys by type
     * @type {string}
     * @memberof StreamKeyListQueryParams
     */
    type?: string | undefined;
    /**
     * Filter stream keys by status
     * @type {string}
     * @memberof StreamKeyListQueryParams
     */
    status?: string | undefined;
    /**
     * Filter stream keys by assigned ingest point id
     * @type {string}
     * @memberof StreamKeyListQueryParams
     */
    assignedIngestPointId?: string | undefined;
    /**
     * Filter stream keys by assigned encoding id
     * @type {string}
     * @memberof StreamKeyListQueryParams
     */
    assignedEncodingId?: string | undefined;
}
export declare class StreamKeyListQueryParamsBuilder {
    private internalParams;
    /**
     *
     * @param offset Index of the first item to return, starting at 0. Default is 0
     */
    offset(offset: number): this;
    /**
     *
     * @param limit Maximum number of items to return. Default is 25, maximum is 100
     */
    limit(limit: number): this;
    /**
     *
     * @param sort Order list result according a stream key attribute.  The fields that can be used for sorting are: + `createdAt` + `name`
     */
    sort(sort: string): this;
    /**
     *
     * @param type Filter stream keys by type
     */
    type(type: string): this;
    /**
     *
     * @param status Filter stream keys by status
     */
    status(status: string): this;
    /**
     *
     * @param assignedIngestPointId Filter stream keys by assigned ingest point id
     */
    assignedIngestPointId(assignedIngestPointId: string): this;
    /**
     *
     * @param assignedEncodingId Filter stream keys by assigned encoding id
     */
    assignedEncodingId(assignedEncodingId: string): this;
    buildQueryParams(): StreamKeyListQueryParams;
}