Class QueryResponseInner


  • public final class QueryResponseInner
    extends Object
    Query result.
    • Constructor Detail

      • QueryResponseInner

        public QueryResponseInner()
    • Method Detail

      • totalRecords

        public long totalRecords()
        Get the totalRecords property: Number of total records matching the query.
        Returns:
        the totalRecords value.
      • withTotalRecords

        public QueryResponseInner withTotalRecords​(long totalRecords)
        Set the totalRecords property: Number of total records matching the query.
        Parameters:
        totalRecords - the totalRecords value to set.
        Returns:
        the QueryResponseInner object itself.
      • count

        public long count()
        Get the count property: Number of records returned in the current response. In the case of paging, this is the number of records in the current page.
        Returns:
        the count value.
      • withCount

        public QueryResponseInner withCount​(long count)
        Set the count property: Number of records returned in the current response. In the case of paging, this is the number of records in the current page.
        Parameters:
        count - the count value to set.
        Returns:
        the QueryResponseInner object itself.
      • resultTruncated

        public ResultTruncated resultTruncated()
        Get the resultTruncated property: Indicates whether the query results are truncated.
        Returns:
        the resultTruncated value.
      • withResultTruncated

        public QueryResponseInner withResultTruncated​(ResultTruncated resultTruncated)
        Set the resultTruncated property: Indicates whether the query results are truncated.
        Parameters:
        resultTruncated - the resultTruncated value to set.
        Returns:
        the QueryResponseInner object itself.
      • skipToken

        public String skipToken()
        Get the skipToken property: When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
        Returns:
        the skipToken value.
      • withSkipToken

        public QueryResponseInner withSkipToken​(String skipToken)
        Set the skipToken property: When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.
        Parameters:
        skipToken - the skipToken value to set.
        Returns:
        the QueryResponseInner object itself.
      • data

        public Object data()
        Get the data property: Query output in JObject array or Table format.
        Returns:
        the data value.
      • withData

        public QueryResponseInner withData​(Object data)
        Set the data property: Query output in JObject array or Table format.
        Parameters:
        data - the data value to set.
        Returns:
        the QueryResponseInner object itself.
      • facets

        public List<Facet> facets()
        Get the facets property: Query facets.
        Returns:
        the facets value.
      • withFacets

        public QueryResponseInner withFacets​(List<Facet> facets)
        Set the facets property: Query facets.
        Parameters:
        facets - the facets value to set.
        Returns:
        the QueryResponseInner object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.