Package video.api.client.api.clients

Class SummariesApi.APIlistRequest

    • Method Detail

      • videoId

        public SummariesApi.APIlistRequest videoId​(String videoId)
        Set videoId
        Parameters:
        videoId - Use this parameter to filter for a summary that belongs to a specific video. (optional)
        Returns:
        APIlistRequest

      • origin

        public SummariesApi.APIlistRequest origin​(String origin)
        Set origin
        Parameters:
        origin - Use this parameter to filter for summaries based on the way they were created: automatically or manually via the API. (optional)
        Returns:
        APIlistRequest

      • sourceStatus

        public SummariesApi.APIlistRequest sourceStatus​(String sourceStatus)
        Set sourceStatus
        Parameters:
        sourceStatus - Use this parameter to filter for summaries based on the current status of the summary source. These are the available statuses: `missing`: the input for a summary is not present. `waiting` : the input video is being processed and a summary will be generated. `failed`: a technical issue prevented summary generation. `completed`: the summary is generated. `unprocessable`: the API rules the source video to be unsuitable for summary generation. An example for this is an input video that has no audio. (optional)
        Returns:
        APIlistRequest

      • sortBy

        public SummariesApi.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: - `createdAt`: Sorts the results based on date and timestamps when summaries were created. - `updatedAt`: Sorts the results based on date and timestamps when summaries were last updated. - `videoId`: Sorts the results based on video IDs. (optional)
        Returns:
        APIlistRequest

      • sortOrder

        public SummariesApi.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 SummariesApi.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 SummariesApi.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 Created * 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<Summary> execute()
                      throws ApiException
        Execute list request
        Returns:
        SummariesListResponse
        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 Created * 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<SummariesListResponse> executeWithHttpInfo()
                                                       throws ApiException
        Execute list request with HTTP info returned
        Returns:
        ApiResponse<SummariesListResponse>
        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 Created * 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<Summary>> _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 Created * 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.