Package video.api.client.api.models

Class FilterBy

java.lang.Object

video.api.client.api.models.FilterBy

All Implemented Interfaces:

Serializable, DeepObject

public class FilterBy
extends Object
implements Serializable, DeepObject

FilterBy

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FilterBy.ContinentEnum	Gets or Sets continent
static class	FilterBy.MediaTypeEnum	Gets or Sets mediaType

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERIALIZED_NAME_BROWSER
static String	SERIALIZED_NAME_CONTINENT
static String	SERIALIZED_NAME_COUNTRY
static String	SERIALIZED_NAME_DEVICE_TYPE
static String	SERIALIZED_NAME_MEDIA_ID
static String	SERIALIZED_NAME_MEDIA_TYPE
static String	SERIALIZED_NAME_OPERATING_SYSTEM
static String	SERIALIZED_NAME_TAG

Constructor Summary

Constructors

Constructor	Description
FilterBy()

Method Summary

Modifier and Type	Method	Description
FilterBy	addBrowserItem(String browserItem)
FilterBy	addContinentItem(FilterBy.ContinentEnum continentItem)
FilterBy	addCountryItem(String countryItem)
FilterBy	addDeviceTypeItem(String deviceTypeItem)
FilterBy	addMediaIdItem(String mediaIdItem)
FilterBy	addOperatingSystemItem(String operatingSystemItem)
FilterBy	browser(List<String> browser)
FilterBy	continent(List<FilterBy.ContinentEnum> continent)
FilterBy	country(List<String> country)
FilterBy	deviceType(List<String> deviceType)
boolean	equals(Object o)
List<String>	getBrowser()	Returns analytics based on the browser used by the viewers.
List<FilterBy.ContinentEnum>	getContinent()	Returns analytics based on the viewers' continent.
List<String>	getCountry()	Returns analytics based on the viewers' country.
List<String>	getDeviceType()	Returns analytics based on the type of device used by the viewers.
List<String>	getMediaId()	Returns analytics based on the unique identifiers of a video or a live stream.
FilterBy.MediaTypeEnum	getMediaType()	Get mediaType
List<String>	getOperatingSystem()	Returns analytics based on the operating system used by the viewers.
String	getTag()	Returns analytics for videos using this tag.
int	hashCode()
FilterBy	mediaId(List<String> mediaId)
FilterBy	mediaType(FilterBy.MediaTypeEnum mediaType)
FilterBy	operatingSystem(List<String> operatingSystem)
void	setBrowser(List<String> browser)
void	setContinent(List<FilterBy.ContinentEnum> continent)
void	setCountry(List<String> country)
void	setDeviceType(List<String> deviceType)
void	setMediaId(List<String> mediaId)
void	setMediaType(FilterBy.MediaTypeEnum mediaType)
void	setOperatingSystem(List<String> operatingSystem)
void	setTag(String tag)
FilterBy	tag(String tag)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_MEDIA_ID

public static final String SERIALIZED_NAME_MEDIA_ID

See Also:

Constant Field Values

SERIALIZED_NAME_MEDIA_TYPE

public static final String SERIALIZED_NAME_MEDIA_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_CONTINENT

public static final String SERIALIZED_NAME_CONTINENT

See Also:

Constant Field Values

SERIALIZED_NAME_COUNTRY

public static final String SERIALIZED_NAME_COUNTRY

See Also:

Constant Field Values

SERIALIZED_NAME_DEVICE_TYPE

public static final String SERIALIZED_NAME_DEVICE_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_OPERATING_SYSTEM

public static final String SERIALIZED_NAME_OPERATING_SYSTEM

See Also:

Constant Field Values

SERIALIZED_NAME_BROWSER

public static final String SERIALIZED_NAME_BROWSER

See Also:

Constant Field Values

SERIALIZED_NAME_TAG

public static final String SERIALIZED_NAME_TAG

See Also:

Constant Field Values

Constructor Detail

FilterBy

public FilterBy()

Method Detail

mediaId

public FilterBy mediaId(List<String> mediaId)

addMediaIdItem

public FilterBy addMediaIdItem(String mediaIdItem)

getMediaId

@Nullable
public List<String> getMediaId()

Returns analytics based on the unique identifiers of a video or a live stream.

Returns:

mediaId

setMediaId

public void setMediaId(List<String> mediaId)

mediaType

public FilterBy mediaType(FilterBy.MediaTypeEnum mediaType)

getMediaType

@Nullable
public FilterBy.MediaTypeEnum getMediaType()

Get mediaType

Returns:

mediaType

setMediaType

public void setMediaType(FilterBy.MediaTypeEnum mediaType)

continent

public FilterBy continent(List<FilterBy.ContinentEnum> continent)

addContinentItem

public FilterBy addContinentItem(FilterBy.ContinentEnum continentItem)

getContinent

@Nullable
public List<FilterBy.ContinentEnum> getContinent()

Returns analytics based on the viewers' continent. The list of supported continents names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example `EU`.

Returns:

continent

setContinent

public void setContinent(List<FilterBy.ContinentEnum> continent)

country

public FilterBy country(List<String> country)

addCountryItem

public FilterBy addCountryItem(String countryItem)

getCountry

@Nullable
public List<String> getCountry()

Returns analytics based on the viewers' country. The list of supported country names are based on the [GeoNames public database](https://www.geonames.org/countries/). You must use the ISO-3166 alpha2 format, for example `FR`.

Returns:

country

setCountry

public void setCountry(List<String> country)

deviceType

public FilterBy deviceType(List<String> deviceType)

addDeviceTypeItem

public FilterBy addDeviceTypeItem(String deviceTypeItem)

getDeviceType

@Nullable
public List<String> getDeviceType()

Returns analytics based on the type of device used by the viewers. Response values can include: `computer`, `phone`, `tablet`, `tv`, `console`, `wearable`, `unknown`.

Returns:

deviceType

setDeviceType

public void setDeviceType(List<String> deviceType)

operatingSystem

public FilterBy operatingSystem(List<String> operatingSystem)

addOperatingSystemItem

public FilterBy addOperatingSystemItem(String operatingSystemItem)

getOperatingSystem

@Nullable
public List<String> getOperatingSystem()

Returns analytics based on the operating system used by the viewers. Response values can include `windows`, `mac osx`, `android`, `ios`, `linux`.

Returns:

operatingSystem

setOperatingSystem

public void setOperatingSystem(List<String> operatingSystem)

browser

public FilterBy browser(List<String> browser)

addBrowserItem

public FilterBy addBrowserItem(String browserItem)

getBrowser

@Nullable
public List<String> getBrowser()

Returns analytics based on the browser used by the viewers. Response values can include `chrome`, `firefox`, `edge`, `opera`.

Returns:

browser

setBrowser

public void setBrowser(List<String> browser)

tag

public FilterBy tag(String tag)

getTag

@Nullable
public String getTag()

Returns analytics for videos using this tag. This filter only accepts a single value and is case sensitive. Read more about tagging your videos [here](https://docs.api.video/vod/tags-metadata).

Returns:

tag

setTag

public void setTag(String tag)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object