Package video.api.client.api.clients

Class RawStatisticsApi.APIlistVideoSessionsRequest

java.lang.Object

video.api.client.api.clients.RawStatisticsApi.APIlistVideoSessionsRequest

Enclosing class:

RawStatisticsApi

public class RawStatisticsApi.APIlistVideoSessionsRequest
extends Object

Method Summary

Modifier and Type	Method	Description
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for listVideoSessions
RawStatisticsApi.APIlistVideoSessionsRequest	currentPage(Integer currentPage)	Set currentPage
Page<VideoSession>	execute()	Execute listVideoSessions request
ApiResponse<RawStatisticsListSessionsResponse>	executeWithHttpInfo()	Execute listVideoSessions request with HTTP info returned
RawStatisticsApi.APIlistVideoSessionsRequest	metadata(Map<String,String> metadata)	Set metadata
RawStatisticsApi.APIlistVideoSessionsRequest	pageSize(Integer pageSize)	Set pageSize
RawStatisticsApi.APIlistVideoSessionsRequest	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.APIlistVideoSessionsRequest 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:

APIlistVideoSessionsRequest

metadata

public RawStatisticsApi.APIlistVideoSessionsRequest metadata(Map<String,String> metadata)

Set metadata

Parameters:

metadata - Metadata and [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata) filter. Send an array of key value pairs you want to filter sessios with. (optional)

Returns:

APIlistVideoSessionsRequest

currentPage

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

APIlistVideoSessionsRequest

pageSize

public RawStatisticsApi.APIlistVideoSessionsRequest pageSize(Integer pageSize)

Set pageSize

Parameters:

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

Returns:

APIlistVideoSessionsRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listVideoSessions

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

Execute listVideoSessions request

Returns:

RawStatisticsListSessionsResponse

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

Execute listVideoSessions request with HTTP info returned

Returns:

ApiResponse<RawStatisticsListSessionsResponse>

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	-