Package video.api.client.api.clients

Class TagsApi.APIlistRequest

  • Enclosing class:
    TagsApi
    public class TagsApi.APIlistRequest
extends Object

    • Method Detail

      • value

        public TagsApi.APIlistRequest value​(String value)
        Set value
        Parameters:
        value - Use this parameter to search for specific video tags. The API filters results even on partial values, and ignores accents, uppercase, and lowercase. (optional)
        Returns:
        APIlistRequest

      • sortBy

        public TagsApi.APIlistRequest sortBy​(String sortBy)
        Set sortBy
        Parameters:
        sortBy - Use this parameter to choose which field the API will use to sort the response data. The default is `value`. These are the available fields to sort by: - `value`: Sorts the results based on tag values in alphabetic order. - `videoCount`: Sorts the results based on the number of times a video tag is used. (optional)
        Returns:
        APIlistRequest

      • sortOrder

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

      • currentPage

        public TagsApi.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 TagsApi.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<ListTagsResponseData> execute()
                                   throws ApiException
        Execute list request
        Returns:
        ListTagsResponse
        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<ListTagsResponse> executeWithHttpInfo()
                                                  throws ApiException
        Execute list request with HTTP info returned
        Returns:
        ApiResponse<ListTagsResponse>
        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<ListTagsResponseData>> _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.