@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
166 lines (165 loc) • 8.42 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.EncodingListQueryParamsBuilder = void 0;
var EncodingListQueryParamsBuilder = /** @class */ (function () {
function EncodingListQueryParamsBuilder() {
this.internalParams = {};
}
/**
*
* @param offset Index of the first item to return, starting at 0. Default is 0
*/
EncodingListQueryParamsBuilder.prototype.offset = function (offset) {
this.internalParams.offset = offset;
return this;
};
/**
*
* @param limit Maximum number of items to return. Default is 25, maximum is 100
*/
EncodingListQueryParamsBuilder.prototype.limit = function (limit) {
this.internalParams.limit = limit;
return this;
};
/**
*
* @param includeTotalCount A boolean indicating whether the total count should be returned as well. Default is false. Setting this flag to true is discouraged.
*/
EncodingListQueryParamsBuilder.prototype.includeTotalCount = function (includeTotalCount) {
this.internalParams.includeTotalCount = includeTotalCount;
return this;
};
/**
*
* @param sort Order list result according an encoding resource attribute. The fields that can be used for sorting are: + `id` + `startedAt` + `createdAt` + `modifiedAt` + `finishedAt` + `type` + `name` + `status` + `cloudRegion` + `encoderVersion`
*/
EncodingListQueryParamsBuilder.prototype.sort = function (sort) {
this.internalParams.sort = sort;
return this;
};
/**
*
* @param type Filter encodings to only show the ones with the type specified.
*/
EncodingListQueryParamsBuilder.prototype.type = function (type) {
this.internalParams.type = type;
return this;
};
/**
*
* @param status Filter encodings to only show the ones with the status specified.
*/
EncodingListQueryParamsBuilder.prototype.status = function (status) {
this.internalParams.status = status;
return this;
};
/**
*
* @param cloudRegion Filter encodings to only show the ones with the cloudRegion specified.
*/
EncodingListQueryParamsBuilder.prototype.cloudRegion = function (cloudRegion) {
this.internalParams.cloudRegion = cloudRegion;
return this;
};
/**
*
* @param selectedCloudRegion Filter encodings to only show the ones with the selectedCloudRegion specified which was selected when cloudregion:AUTO was set
*/
EncodingListQueryParamsBuilder.prototype.selectedCloudRegion = function (selectedCloudRegion) {
this.internalParams.selectedCloudRegion = selectedCloudRegion;
return this;
};
/**
*
* @param encoderVersion Filter encodings to only show the ones with the encoderVersion specified.
*/
EncodingListQueryParamsBuilder.prototype.encoderVersion = function (encoderVersion) {
this.internalParams.encoderVersion = encoderVersion;
return this;
};
/**
*
* @param selectedEncoderVersion Filter encodings to only show the ones with the encoderVersion specified that was actually used for the encoding.
*/
EncodingListQueryParamsBuilder.prototype.selectedEncoderVersion = function (selectedEncoderVersion) {
this.internalParams.selectedEncoderVersion = selectedEncoderVersion;
return this;
};
/**
*
* @param selectedEncodingMode Filter encodings to only show the ones with the encodingMode specified that was actually used for the encoding.
*/
EncodingListQueryParamsBuilder.prototype.selectedEncodingMode = function (selectedEncodingMode) {
this.internalParams.selectedEncodingMode = selectedEncodingMode;
return this;
};
/**
*
* @param name Filter encodings to only show the ones with this exact name.
*/
EncodingListQueryParamsBuilder.prototype.name = function (name) {
this.internalParams.name = name;
return this;
};
/**
*
* @param search The search query string for advanced filtering. We are using the [Apache Lucene](https://lucene.apache.org/) query syntax here. Only lucene queries equivalent to exact matching and startsWith are supported. Also only AND conjunctions supported at the moment. Please be aware that our filters are **case-insensitive** Examples of supported lucene queries: + `name:MyEncoding1` - This searches for encodings with names that are equal to `myencoding1` + `name:\"My Encoding\"` - This searches for encodings with names that are equal to `my encoding` + `name:MyEncoding\\*` - This searches for encodings with names that are equal to `myencoding*` Please have a look at the [Lucene Documentation - Escaping Special Characters](https://lucene.apache.org/core/8_1_1/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#Escaping_Special_Characters) section to see what characters have to be escaped. + `name:test*` - This searches for encodings with names that start with `test` + `name:test* AND labels:Customer1` - This searches for encodings with names starting with `test` and labels containing an entry that is equal to `customer1` Available search fields: + `name` + `labels` Please be aware to send these queries url encoded. If you provide fields or lucene queries that are not supported, it will result in an error response.
*/
EncodingListQueryParamsBuilder.prototype.search = function (search) {
this.internalParams.search = search;
return this;
};
/**
*
* @param createdAtNewerThan Filter encodings to only return those created after this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
*/
EncodingListQueryParamsBuilder.prototype.createdAtNewerThan = function (createdAtNewerThan) {
this.internalParams.createdAtNewerThan = createdAtNewerThan;
return this;
};
/**
*
* @param createdAtOlderThan Filter encodings to only return those created before this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
*/
EncodingListQueryParamsBuilder.prototype.createdAtOlderThan = function (createdAtOlderThan) {
this.internalParams.createdAtOlderThan = createdAtOlderThan;
return this;
};
/**
*
* @param startedAtNewerThan Filter encodings to only return those started after this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
*/
EncodingListQueryParamsBuilder.prototype.startedAtNewerThan = function (startedAtNewerThan) {
this.internalParams.startedAtNewerThan = startedAtNewerThan;
return this;
};
/**
*
* @param startedAtOlderThan Filter encodings to only return those started before this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
*/
EncodingListQueryParamsBuilder.prototype.startedAtOlderThan = function (startedAtOlderThan) {
this.internalParams.startedAtOlderThan = startedAtOlderThan;
return this;
};
/**
*
* @param finishedAtNewerThan Filter encodings to only return those finished at newer than this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Available for all encodings started after REST API Service release v1.50.0 (Changelogs for more information https://bitmovin.com/docs/encoding/changelogs/rest)
*/
EncodingListQueryParamsBuilder.prototype.finishedAtNewerThan = function (finishedAtNewerThan) {
this.internalParams.finishedAtNewerThan = finishedAtNewerThan;
return this;
};
/**
*
* @param finishedAtOlderThan Filter encodings to only return those finished at older than this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Available for all encodings started after REST API Service release v1.50.0 (Changelogs for more information https://bitmovin.com/docs/encoding/changelogs/rest)
*/
EncodingListQueryParamsBuilder.prototype.finishedAtOlderThan = function (finishedAtOlderThan) {
this.internalParams.finishedAtOlderThan = finishedAtOlderThan;
return this;
};
EncodingListQueryParamsBuilder.prototype.buildQueryParams = function () {
return this.internalParams;
};
return EncodingListQueryParamsBuilder;
}());
exports.EncodingListQueryParamsBuilder = EncodingListQueryParamsBuilder;