@bitmovin/api-sdk/dist/encoding/outputs/OutputListQueryParams.d.ts

Bitmovin JS/TS API SDK

import OutputType from '../../models/OutputType';
export interface OutputListQueryParams {
    /**
     * Index of the first item to return, starting at 0. Default is 0
     * @type {number}
     * @memberof OutputListQueryParams
     */
    offset?: number | undefined;
    /**
     * Maximum number of items to return. Default is 25, maximum is 100
     * @type {number}
     * @memberof OutputListQueryParams
     */
    limit?: number | undefined;
    /**
     * Filter outputs by name
     * @type {string}
     * @memberof OutputListQueryParams
     */
    name?: string | undefined;
    /**
     * Order list result according to a output resource attribute. The fields that can be used for sorting are: + `id` + `createdAt` + `modifiedAt` + `type` + `name`
     * @type {string}
     * @memberof OutputListQueryParams
     */
    sort?: string | undefined;
    /**
     * Filter outputs by type
     * @type {OutputType}
     * @memberof OutputListQueryParams
     */
    type?: OutputType | undefined;
}
export declare class OutputListQueryParamsBuilder {
    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 name Filter outputs by name
     */
    name(name: string): this;
    /**
     *
     * @param sort Order list result according to a output resource attribute. The fields that can be used for sorting are: + `id` + `createdAt` + `modifiedAt` + `type` + `name`
     */
    sort(sort: string): this;
    /**
     *
     * @param type Filter outputs by type
     */
    type(type: OutputType): this;
    buildQueryParams(): OutputListQueryParams;
}