Package com.twitter.clientlib.api

Class TweetsApi.APItweetCountsFullArchiveSearchRequest

  • Enclosing class:
    TweetsApi
    public class TweetsApi.APItweetCountsFullArchiveSearchRequest
extends Object

    • Method Detail

      • startTime

        public TweetsApi.APItweetCountsFullArchiveSearchRequest startTime​(OffsetDateTime startTime)
        Set startTime
        Parameters:
        startTime - YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp (from most recent 7 days) from which the Tweets will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute). (optional)
        Returns:
        APItweetCountsFullArchiveSearchRequest

      • endTime

        public TweetsApi.APItweetCountsFullArchiveSearchRequest endTime​(OffsetDateTime endTime)
        Set endTime
        Parameters:
        endTime - YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Tweets will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute). (optional)
        Returns:
        APItweetCountsFullArchiveSearchRequest

      • sinceId

        public TweetsApi.APItweetCountsFullArchiveSearchRequest sinceId​(String sinceId)
        Set sinceId
        Parameters:
        sinceId - Returns results with a Tweet ID greater than (that is, more recent than) the specified ID. (optional)
        Returns:
        APItweetCountsFullArchiveSearchRequest

      • untilId

        public TweetsApi.APItweetCountsFullArchiveSearchRequest untilId​(String untilId)
        Set untilId
        Parameters:
        untilId - Returns results with a Tweet ID less than (that is, older than) the specified ID. (optional)
        Returns:
        APItweetCountsFullArchiveSearchRequest

      • nextToken

        public TweetsApi.APItweetCountsFullArchiveSearchRequest nextToken​(String nextToken)
        Set nextToken
        Parameters:
        nextToken - This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. (optional)
        Returns:
        APItweetCountsFullArchiveSearchRequest

      • paginationToken

        public TweetsApi.APItweetCountsFullArchiveSearchRequest paginationToken​(String paginationToken)
        Set paginationToken
        Parameters:
        paginationToken - This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. (optional)
        Returns:
        APItweetCountsFullArchiveSearchRequest

      • granularity

        public TweetsApi.APItweetCountsFullArchiveSearchRequest granularity​(String granularity)
        Set granularity
        Parameters:
        granularity - The granularity for the search counts results. (optional, default to hour)
        Returns:
        APItweetCountsFullArchiveSearchRequest

      • searchCountFields

        public TweetsApi.APItweetCountsFullArchiveSearchRequest searchCountFields​(Set<String> searchCountFields)
        Set searchCountFields
        Parameters:
        searchCountFields - A comma separated list of SearchCount fields to display. (optional)
        Returns:
        APItweetCountsFullArchiveSearchRequest

      • buildCall

        public okhttp3.Call buildCall​(ApiCallback _callback)
                       throws ApiException
        Build call for tweetCountsFullArchiveSearch
        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 The request has succeeded. -
        0 The request has failed. -

      • execute

        public Get2TweetsCountsAllResponse execute()
                                    throws ApiException
        Execute tweetCountsFullArchiveSearch request
        Returns:
        Get2TweetsCountsAllResponse
        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 The request has succeeded. -
        0 The request has failed. -

      • executeWithHttpInfo

        public ApiResponse<Get2TweetsCountsAllResponse> executeWithHttpInfo()
                                                             throws ApiException
        Execute tweetCountsFullArchiveSearch request with HTTP info returned
        Returns:
        ApiResponse<Get2TweetsCountsAllResponse>
        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 The request has succeeded. -
        0 The request has failed. -

      • executeAsync

        public okhttp3.Call executeAsync​(ApiCallback<Get2TweetsCountsAllResponse> _callback)
                          throws ApiException
        Execute tweetCountsFullArchiveSearch 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 The request has succeeded. -
        0 The request has failed. -