Package video.api.client.api.clients

Class VideosApi.APIlistRequest

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

    • Method Detail

      • title

        public VideosApi.APIlistRequest title​(String title)
        Set title
        Parameters:
        title - The title of a specific video you want to find. The search will match exactly to what term you provide and return any videos that contain the same term as part of their titles. (optional)
        Returns:
        APIlistRequest

      • tags

        public VideosApi.APIlistRequest tags​(List<String> tags)
        Set tags
        Parameters:
        tags - A tag is a category you create and apply to videos. You can search for videos with particular tags by listing one or more here. Only videos that have all the tags you list will be returned. (optional)
        Returns:
        APIlistRequest

      • metadata

        public VideosApi.APIlistRequest metadata​(Map<String,​String> metadata)
        Set metadata
        Parameters:
        metadata - Videos can be tagged with metadata tags in key:value pairs. You can search for videos with specific key value pairs using this parameter. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata) allows you to define a key that allows any value pair. (optional)
        Returns:
        APIlistRequest

      • description

        public VideosApi.APIlistRequest description​(String description)
        Set description
        Parameters:
        description - If you described a video with a term or sentence, you can add it here to return videos containing this string. (optional)
        Returns:
        APIlistRequest

      • liveStreamId

        public VideosApi.APIlistRequest liveStreamId​(String liveStreamId)
        Set liveStreamId
        Parameters:
        liveStreamId - If you know the ID for a live stream, you can retrieve the stream by adding the ID for it here. (optional)
        Returns:
        APIlistRequest

      • sortBy

        public VideosApi.APIlistRequest sortBy​(String sortBy)
        Set sortBy
        Parameters:
        sortBy - Allowed: publishedAt, title. You can search by the time videos were published at, or by title. (optional)
        Returns:
        APIlistRequest

      • sortOrder

        public VideosApi.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 VideosApi.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 VideosApi.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 -
        400 Bad Request -

      • execute

        public Page<Video> execute()
                    throws ApiException
        Execute list request
        Returns:
        VideosListResponse
        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 -
        400 Bad Request -

      • executeWithHttpInfo

        public ApiResponse<VideosListResponse> executeWithHttpInfo()
                                                    throws ApiException
        Execute list request with HTTP info returned
        Returns:
        ApiResponse<VideosListResponse>
        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 -
        400 Bad Request -

      • executeAsync

        public okhttp3.Call executeAsync​(ApiCallback<Page<Video>> _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 -
        400 Bad Request -