Package video.api.client.api.clients

Class LiveStreamsApi.APIlistRequest

java.lang.Object

video.api.client.api.clients.LiveStreamsApi.APIlistRequest

Enclosing class:

LiveStreamsApi

public class LiveStreamsApi.APIlistRequest
extends Object

Method Summary

Modifier and Type	Method	Description
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for list
LiveStreamsApi.APIlistRequest	currentPage(Integer currentPage)	Set currentPage
Page<LiveStream>	execute()	Execute list request
okhttp3.Call	executeAsync(ApiCallback<Page<LiveStream>> _callback)	Execute list request (asynchronously)
ApiResponse<LiveStreamListResponse>	executeWithHttpInfo()	Execute list request with HTTP info returned
LiveStreamsApi.APIlistRequest	name(String name)	Set name
LiveStreamsApi.APIlistRequest	pageSize(Integer pageSize)	Set pageSize
LiveStreamsApi.APIlistRequest	sortBy(String sortBy)	Set sortBy
LiveStreamsApi.APIlistRequest	sortOrder(String sortOrder)	Set sortOrder
LiveStreamsApi.APIlistRequest	streamKey(String streamKey)	Set streamKey

Methods inherited from class java.lang.Object

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

Method Detail

streamKey

public LiveStreamsApi.APIlistRequest streamKey(String streamKey)

Set streamKey

Parameters:

streamKey - The unique stream key that allows you to stream videos. (optional)

Returns:

APIlistRequest

name

public LiveStreamsApi.APIlistRequest name(String name)

Set name

Parameters:

name - You can filter live streams by their name or a part of their name. (optional)

Returns:

APIlistRequest

sortBy

public LiveStreamsApi.APIlistRequest sortBy(String sortBy)

Set sortBy

Parameters:

sortBy - Enables you to sort live stream results. Allowed attributes: `name`, `createdAt`, `updatedAt`. `name` - the name of the live stream. `createdAt` - the time a live stream was created. `updatedAt` - the time a live stream was last updated. When using `createdAt` or `updatedAt`, the API sorts the results based on the ATOM UTC time format. (optional)

Returns:

APIlistRequest

sortOrder

public LiveStreamsApi.APIlistRequest sortOrder(String sortOrder)

Set sortOrder

Parameters:

sortOrder - Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. For title, it is 0-9 and A-Z ascending and Z-A, 9-0 descending. (optional)

Returns:

APIlistRequest

currentPage

public LiveStreamsApi.APIlistRequest 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:

APIlistRequest

pageSize

public LiveStreamsApi.APIlistRequest pageSize(Integer pageSize)

Set pageSize

Parameters:

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

Returns:

APIlistRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for list

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.
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<LiveStream> execute()
                         throws ApiException

Execute list request

Returns:

LiveStreamListResponse

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.
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<LiveStreamListResponse> executeWithHttpInfo()
                                                        throws ApiException

Execute list request with HTTP info returned

Returns:

ApiResponse<LiveStreamListResponse>

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.
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<LiveStream>> _callback)
                          throws ApiException

Execute list 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.
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.