com.bitmovin.api.sdk.encoding.encodings

Class EncodingListQueryParams

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

com.bitmovin.api.sdk.encoding.encodings.EncodingListQueryParams

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class EncodingListQueryParams
extends HashMap<String,Object>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
EncodingListQueryParams()

Method Summary

Modifier and Type	Method and Description
CloudRegion	getCloudRegion()
String	getEncoderVersion()
Integer	getLimit()
String	getName()
Integer	getOffset()
String	getSearch()
String	getSort()
String	getStatus()
String	getType()
void	setCloudRegion(CloudRegion cloudRegion)
void	setEncoderVersion(String encoderVersion)
void	setLimit(Integer limit)
void	setName(String name)
void	setOffset(Integer offset)
void	setSearch(String search)
void	setSort(String sort)
void	setStatus(String status)
void	setType(String type)

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

EncodingListQueryParams

public EncodingListQueryParams()

Method Detail

getOffset

public Integer getOffset()

setOffset

public void setOffset(Integer offset)

Parameters:

offset - Index of the first item to return, starting at 0. Default is 0 (optional)

getLimit

public Integer getLimit()

setLimit

public void setLimit(Integer limit)

Parameters:

limit - Maximum number of items to return. Default is 25, maximum is 100 (optional)

getSort

public String getSort()

setSort

public void setSort(String sort)

Parameters:

sort - Order list result according an encoding resource attribute (optional)

getType

public String getType()

setType

public void setType(String type)

Parameters:

type - Filter encodings to only show the ones with the type specified. (optional)

getStatus

public String getStatus()

setStatus

public void setStatus(String status)

Parameters:

status - Filter encodings to only show the ones with the status specified. (optional)

getCloudRegion

public CloudRegion getCloudRegion()

setCloudRegion

public void setCloudRegion(CloudRegion cloudRegion)

Parameters:

cloudRegion - Filter encodings to only show the ones with the cloudRegion specified. (optional, default to null)

getEncoderVersion

public String getEncoderVersion()

setEncoderVersion

public void setEncoderVersion(String encoderVersion)

Parameters:

encoderVersion - Filter encodings to only show the ones with the encoderVersion specified. (optional)

getName

public String getName()

setName

public void setName(String name)

Parameters:

name - Filter encodings to only show the ones with this exact name. (optional)

getSearch

public String getSearch()

setSearch

public void setSearch(String search)

Parameters:

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. (optional)