Class EncodingsApi.ListQueryParams
Inheritance
System.Object
System.Collections.Generic.Dictionary<System.String, System.Object>
EncodingsApi.ListQueryParams
Implements
System.Collections.Generic.IDictionary<System.String, System.Object>
System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, System.Object>>
System.Collections.IDictionary
System.Collections.ICollection
System.Collections.Generic.IReadOnlyDictionary<System.String, System.Object>
System.Collections.Generic.IReadOnlyCollection<System.Collections.Generic.KeyValuePair<System.String, System.Object>>
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String, System.Object>>
System.Collections.IEnumerable
System.Runtime.Serialization.ISerializable
System.Runtime.Serialization.IDeserializationCallback
Inherited Members
System.Collections.Generic.Dictionary<System.String, System.Object>.Add(System.String, System.Object)
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, System.Object>>.Add(System.Collections.Generic.KeyValuePair<System.String, System.Object>)
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, System.Object>>.Contains(System.Collections.Generic.KeyValuePair<System.String, System.Object>)
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, System.Object>>.Remove(System.Collections.Generic.KeyValuePair<System.String, System.Object>)
System.Collections.Generic.Dictionary<System.String, System.Object>.Clear()
System.Collections.Generic.Dictionary<System.String, System.Object>.ContainsKey(System.String)
System.Collections.Generic.Dictionary<System.String, System.Object>.ContainsValue(System.Object)
System.Collections.Generic.Dictionary<System.String, System.Object>.GetEnumerator()
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String, System.Object>>.GetEnumerator()
System.Collections.Generic.Dictionary<System.String, System.Object>.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext)
System.Collections.Generic.Dictionary<System.String, System.Object>.OnDeserialization(System.Object)
System.Collections.Generic.Dictionary<System.String, System.Object>.Remove(System.String)
System.Collections.Generic.Dictionary<System.String, System.Object>.TryGetValue(System.String, System.Object)
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, System.Object>>.CopyTo(System.Collections.Generic.KeyValuePair<System.String, System.Object>[], System.Int32)
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.ICollection.CopyTo(System.Array, System.Int32)
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.IEnumerable.GetEnumerator()
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.IDictionary.get_Item(System.Object)
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.IDictionary.set_Item(System.Object, System.Object)
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.IDictionary.Add(System.Object, System.Object)
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.IDictionary.Contains(System.Object)
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.IDictionary.GetEnumerator()
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.IDictionary.Remove(System.Object)
System.Collections.Generic.Dictionary<System.String, System.Object>.Comparer
System.Collections.Generic.Dictionary<System.String, System.Object>.Count
System.Collections.Generic.Dictionary<System.String, System.Object>.Keys
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.Generic.IDictionary<System.String, System.Object>.Keys
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.Generic.IReadOnlyDictionary<System.String, System.Object>.Keys
System.Collections.Generic.Dictionary<System.String, System.Object>.Values
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.Generic.IDictionary<System.String, System.Object>.Values
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.Generic.IReadOnlyDictionary<System.String, System.Object>.Values
System.Collections.Generic.Dictionary<System.String, System.Object>.Item[System.String]
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, System.Object>>.IsReadOnly
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.ICollection.IsSynchronized
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.ICollection.SyncRoot
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.IDictionary.IsFixedSize
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.IDictionary.IsReadOnly
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.IDictionary.Keys
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.IDictionary.Values
System.Collections.Generic.Dictionary<System.String, System.Object>.System.Collections.IDictionary.Item[System.Object]
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class ListQueryParams : Dictionary<string, object>, IDictionary<string, object>, ICollection<KeyValuePair<string, object>>, IDictionary, ICollection, IReadOnlyDictionary<string, object>, IReadOnlyCollection<KeyValuePair<string, object>>, IEnumerable<KeyValuePair<string, object>>, IEnumerable, ISerializable, IDeserializationCallback
Methods
CloudRegion(CloudRegion)
Filter encodings to only show the ones with the cloudRegion specified.
Declaration
public EncodingsApi.ListQueryParams CloudRegion(CloudRegion cloudRegion)
Parameters
Returns
CreatedAtNewerThan(Nullable<DateTime>)
Filter encodings to only return those created after this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
Declaration
public EncodingsApi.ListQueryParams CreatedAtNewerThan(DateTime? createdAtNewerThan)
Parameters
| Type |
Name |
Description |
| System.Nullable<System.DateTime> |
createdAtNewerThan |
|
Returns
CreatedAtOlderThan(Nullable<DateTime>)
Filter encodings to only return those created before this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
Declaration
public EncodingsApi.ListQueryParams CreatedAtOlderThan(DateTime? createdAtOlderThan)
Parameters
| Type |
Name |
Description |
| System.Nullable<System.DateTime> |
createdAtOlderThan |
|
Returns
EncoderVersion(String)
Filter encodings to only show the ones with the encoderVersion specified.
Declaration
public EncodingsApi.ListQueryParams EncoderVersion(string encoderVersion)
Parameters
| Type |
Name |
Description |
| System.String |
encoderVersion |
|
Returns
FinishedAtNewerThan(Nullable<DateTime>)
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)
Declaration
public EncodingsApi.ListQueryParams FinishedAtNewerThan(DateTime? finishedAtNewerThan)
Parameters
| Type |
Name |
Description |
| System.Nullable<System.DateTime> |
finishedAtNewerThan |
|
Returns
FinishedAtOlderThan(Nullable<DateTime>)
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)
Declaration
public EncodingsApi.ListQueryParams FinishedAtOlderThan(DateTime? finishedAtOlderThan)
Parameters
| Type |
Name |
Description |
| System.Nullable<System.DateTime> |
finishedAtOlderThan |
|
Returns
Limit(Nullable<Int32>)
Maximum number of items to return. Default is 25, maximum is 100
Declaration
public EncodingsApi.ListQueryParams Limit(int? limit)
Parameters
| Type |
Name |
Description |
| System.Nullable<System.Int32> |
limit |
|
Returns
Name(String)
Filter encodings to only show the ones with this exact name.
Declaration
public EncodingsApi.ListQueryParams Name(string name)
Parameters
| Type |
Name |
Description |
| System.String |
name |
|
Returns
Offset(Nullable<Int32>)
Index of the first item to return, starting at 0. Default is 0
Declaration
public EncodingsApi.ListQueryParams Offset(int? offset)
Parameters
| Type |
Name |
Description |
| System.Nullable<System.Int32> |
offset |
|
Returns
Search(String)
The search query string for advanced filtering. We are using the Apache Lucene 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 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.
Declaration
public EncodingsApi.ListQueryParams Search(string search)
Parameters
| Type |
Name |
Description |
| System.String |
search |
|
Returns
SelectedCloudRegion(CloudRegion)
Filter encodings to only show the ones with the selectedCloudRegion specified which was selected when cloudregion:AUTO was set
Declaration
public EncodingsApi.ListQueryParams SelectedCloudRegion(CloudRegion selectedCloudRegion)
Parameters
Returns
SelectedEncoderVersion(String)
Filter encodings to only show the ones with the encoderVersion specified that was actually used for the encoding.
Declaration
public EncodingsApi.ListQueryParams SelectedEncoderVersion(string selectedEncoderVersion)
Parameters
| Type |
Name |
Description |
| System.String |
selectedEncoderVersion |
|
Returns
SelectedEncodingMode(EncodingMode)
Filter encodings to only show the ones with the encodingMode specified that was actually used for the encoding.
Declaration
public EncodingsApi.ListQueryParams SelectedEncodingMode(EncodingMode selectedEncodingMode)
Parameters
Returns
Sort(String)
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
Declaration
public EncodingsApi.ListQueryParams Sort(string sort)
Parameters
| Type |
Name |
Description |
| System.String |
sort |
|
Returns
StartedAtNewerThan(Nullable<DateTime>)
Filter encodings to only return those started after this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
Declaration
public EncodingsApi.ListQueryParams StartedAtNewerThan(DateTime? startedAtNewerThan)
Parameters
| Type |
Name |
Description |
| System.Nullable<System.DateTime> |
startedAtNewerThan |
|
Returns
StartedAtOlderThan(Nullable<DateTime>)
Filter encodings to only return those started before this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
Declaration
public EncodingsApi.ListQueryParams StartedAtOlderThan(DateTime? startedAtOlderThan)
Parameters
| Type |
Name |
Description |
| System.Nullable<System.DateTime> |
startedAtOlderThan |
|
Returns
Status(String)
Filter encodings to only show the ones with the status specified.
Declaration
public EncodingsApi.ListQueryParams Status(string status)
Parameters
| Type |
Name |
Description |
| System.String |
status |
|
Returns
Type(String)
Filter encodings to only show the ones with the type specified.
Declaration
public EncodingsApi.ListQueryParams Type(string type)
Parameters
| Type |
Name |
Description |
| System.String |
type |
|
Returns
Implements
System.Collections.Generic.IDictionary<TKey, TValue>
System.Collections.Generic.ICollection<T>
System.Collections.IDictionary
System.Collections.ICollection
System.Collections.Generic.IReadOnlyDictionary<TKey, TValue>
System.Collections.Generic.IReadOnlyCollection<T>
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable
System.Runtime.Serialization.ISerializable
System.Runtime.Serialization.IDeserializationCallback