Package video.api.client.api.clients

Class WatermarksApi.APIlistRequest

java.lang.Object

video.api.client.api.clients.WatermarksApi.APIlistRequest

Enclosing class:

WatermarksApi

public class WatermarksApi.APIlistRequest
extends Object

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

sortBy

public WatermarksApi.APIlistRequest sortBy(String sortBy)

Set sortBy

Parameters:

sortBy - Allowed: createdAt. You can search by the time watermark were created at. (optional)

Returns:

APIlistRequest

sortOrder

public WatermarksApi.APIlistRequest sortOrder(String sortOrder)

Set sortOrder

Parameters:

sortOrder - Allowed: asc, desc. asc is ascending and sorts from A to Z. desc is descending and sorts from Z to A. (optional)

Returns:

APIlistRequest

currentPage

public WatermarksApi.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 WatermarksApi.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.
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<Watermark> execute()
                        throws ApiException

Execute list request

Returns:

WatermarksListResponse

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

Execute list request with HTTP info returned

Returns:

ApiResponse<WatermarksListResponse>

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<Watermark>> _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.
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.