Package video.api.client.api.clients

Class RawStatisticsApi.APIlistLiveStreamSessionsRequest

java.lang.Object

video.api.client.api.clients.RawStatisticsApi.APIlistLiveStreamSessionsRequest

Enclosing class:

RawStatisticsApi

public class RawStatisticsApi.APIlistLiveStreamSessionsRequest
extends Object

Method Summary

Modifier and Type	Method	Description
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for listLiveStreamSessions
RawStatisticsApi.APIlistLiveStreamSessionsRequest	currentPage(Integer currentPage)	Set currentPage
Page<LiveStreamSession>	execute()	Execute listLiveStreamSessions request
ApiResponse<RawStatisticsListLiveStreamAnalyticsResponse>	executeWithHttpInfo()	Execute listLiveStreamSessions request with HTTP info returned
RawStatisticsApi.APIlistLiveStreamSessionsRequest	pageSize(Integer pageSize)	Set pageSize
RawStatisticsApi.APIlistLiveStreamSessionsRequest	period(String period)	Set period

Methods inherited from class java.lang.Object

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

Method Detail

period

public RawStatisticsApi.APIlistLiveStreamSessionsRequest period(String period)

Set period

Parameters:

period - Period must have one of the following formats: - For a day : \"2018-01-01\", - For a week: \"2018-W01\", - For a month: \"2018-01\" - For a year: \"2018\" For a range period: - Date range: \"2018-01-01/2018-01-15\" (optional)

Returns:

APIlistLiveStreamSessionsRequest

currentPage

public RawStatisticsApi.APIlistLiveStreamSessionsRequest 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:

APIlistLiveStreamSessionsRequest

pageSize

public RawStatisticsApi.APIlistLiveStreamSessionsRequest pageSize(Integer pageSize)

Set pageSize

Parameters:

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

Returns:

APIlistLiveStreamSessionsRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listLiveStreamSessions

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	-
404	Not Found	-

execute

public Page<LiveStreamSession> execute()
                                throws ApiException

Execute listLiveStreamSessions request

Returns:

RawStatisticsListLiveStreamAnalyticsResponse

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	-
404	Not Found	-

executeWithHttpInfo

public ApiResponse<RawStatisticsListLiveStreamAnalyticsResponse> executeWithHttpInfo()
                                                                              throws ApiException

Execute listLiveStreamSessions request with HTTP info returned

Returns:

ApiResponse<RawStatisticsListLiveStreamAnalyticsResponse>

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	-
404	Not Found	-