Package video.api.client.api.clients

Class VideosApi.APIlistDiscardedRequest

java.lang.Object

video.api.client.api.clients.VideosApi.APIlistDiscardedRequest

Enclosing class:

VideosApi

public class VideosApi.APIlistDiscardedRequest
extends Object

Method Summary

Modifier and Type	Method	Description
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for listDiscarded
VideosApi.APIlistDiscardedRequest	currentPage(Integer currentPage)	Set currentPage
VideosApi.APIlistDiscardedRequest	description(String description)	Set description
Page<Video>	execute()	Execute listDiscarded request
okhttp3.Call	executeAsync(ApiCallback<Page<Video>> _callback)	Execute listDiscarded request (asynchronously)
ApiResponse<VideosListResponse>	executeWithHttpInfo()	Execute listDiscarded request with HTTP info returned
VideosApi.APIlistDiscardedRequest	liveStreamId(String liveStreamId)	Set liveStreamId
VideosApi.APIlistDiscardedRequest	metadata(Map<String,String> metadata)	Set metadata
VideosApi.APIlistDiscardedRequest	pageSize(Integer pageSize)	Set pageSize
VideosApi.APIlistDiscardedRequest	sortBy(String sortBy)	Set sortBy
VideosApi.APIlistDiscardedRequest	sortOrder(String sortOrder)	Set sortOrder
VideosApi.APIlistDiscardedRequest	tags(List<String> tags)	Set tags
VideosApi.APIlistDiscardedRequest	title(String title)	Set title

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

title

public VideosApi.APIlistDiscardedRequest title(String title)

Set title

Parameters:

title - The title of a specific video you want to find. The search will match exactly to what term you provide and return any videos that contain the same term as part of their titles. (optional)

Returns:

APIlistDiscardedRequest

tags

public VideosApi.APIlistDiscardedRequest tags(List<String> tags)

Set tags

Parameters:

tags - A tag is a category you create and apply to videos. You can search for videos with particular tags by listing one or more here. Only videos that have all the tags you list will be returned. (optional)

Returns:

APIlistDiscardedRequest

metadata

public VideosApi.APIlistDiscardedRequest metadata(Map<String,String> metadata)

Set metadata

Parameters:

metadata - Videos can be tagged with metadata tags in key:value pairs. You can search for videos with specific key value pairs using this parameter. (optional)

Returns:

APIlistDiscardedRequest

description

public VideosApi.APIlistDiscardedRequest description(String description)

Set description

Parameters:

description - Retrieve video objects by `description`. (optional)

Returns:

APIlistDiscardedRequest

liveStreamId

public VideosApi.APIlistDiscardedRequest liveStreamId(String liveStreamId)

Set liveStreamId

Parameters:

liveStreamId - Retrieve video objects that were recorded from a live stream by `liveStreamId`. (optional)

Returns:

APIlistDiscardedRequest

sortBy

public VideosApi.APIlistDiscardedRequest sortBy(String sortBy)

Set sortBy

Parameters:

sortBy - Use this parameter to sort videos by the their created time, published time, updated time, or by title. (optional)

Returns:

APIlistDiscardedRequest

sortOrder

public VideosApi.APIlistDiscardedRequest sortOrder(String sortOrder)

Set sortOrder

Parameters:

sortOrder - Use this parameter to sort results. `asc` is ascending and sorts from A to Z. `desc` is descending and sorts from Z to A. (optional)

Returns:

APIlistDiscardedRequest

currentPage

public VideosApi.APIlistDiscardedRequest currentPage(Integer currentPage)

Set currentPage

Parameters:

currentPage - Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)

Returns:

APIlistDiscardedRequest

pageSize

public VideosApi.APIlistDiscardedRequest pageSize(Integer pageSize)

Set pageSize

Parameters:

pageSize - Results per page. Allowed values 1-100, default is 25. (optional, default to 25)

Returns:

APIlistDiscardedRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listDiscarded

Parameters:

_callback - ApiCallback API callback

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad Request	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

execute

public Page<Video> execute()
                    throws ApiException

Execute listDiscarded request

Returns:

VideosListResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad Request	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

executeWithHttpInfo

public ApiResponse<VideosListResponse> executeWithHttpInfo()
                                                    throws ApiException

Execute listDiscarded request with HTTP info returned

Returns:

ApiResponse<VideosListResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad Request	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

executeAsync

public okhttp3.Call executeAsync(ApiCallback<Page<Video>> _callback)
                          throws ApiException

Execute listDiscarded request (asynchronously)

Parameters:

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Success	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400	Bad Request	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429	Too Many Requests	* X-RateLimit-Limit - The request limit per minute. * X-RateLimit-Remaining - The number of available requests left for the current time window. * X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.