Package com.azure.analytics.purview.datamap.models

Class QueryOptions

java.lang.Object
com.azure.analytics.purview.datamap.models.QueryOptions
All Implemented Interfaces:
com.azure.json.JsonSerializable<QueryOptions>
public final class QueryOptions extends Object implements com.azure.json.JsonSerializable<QueryOptions>
The search query of advanced search request.

  • Constructor Details

    • QueryOptions

      public QueryOptions()
      Creates an instance of QueryOptions class.

  • Method Details

    • getKeywords

      public String getKeywords()
      Get the keywords property: The keywords applied to all searchable fields.
      Returns:
      the keywords value.

    • setKeywords

      public QueryOptions setKeywords(String keywords)
      Set the keywords property: The keywords applied to all searchable fields.
      Parameters:
      keywords - the keywords value to set.
      Returns:
      the QueryOptions object itself.

    • getLimit

      public Integer getLimit()
      Get the limit property: The limit of the number of the search result. default value is 50; maximum value is 1000.
      Returns:
      the limit value.

    • setLimit

      public QueryOptions setLimit(Integer limit)
      Set the limit property: The limit of the number of the search result. default value is 50; maximum value is 1000.
      Parameters:
      limit - the limit value to set.
      Returns:
      the QueryOptions object itself.

    • getContinuationToken

      public String getContinuationToken()
      Get the continuationToken property: The token used to get next batch of data. Default 'Null' to get the first batch, and will return new token in each response unless there's no more data.
      Returns:
      the continuationToken value.

    • setContinuationToken

      public QueryOptions setContinuationToken(String continuationToken)
      Set the continuationToken property: The token used to get next batch of data. Default 'Null' to get the first batch, and will return new token in each response unless there's no more data.
      Parameters:
      continuationToken - the continuationToken value to set.
      Returns:
      the QueryOptions object itself.

    • getOrderby

      public List<com.azure.core.util.BinaryData> getOrderby()
      Get the orderby property: The sort order of search results, can specify multiple fields.
      Returns:
      the orderby value.

    • setOrderby

      public QueryOptions setOrderby(List<com.azure.core.util.BinaryData> orderby)
      Set the orderby property: The sort order of search results, can specify multiple fields.
      Parameters:
      orderby - the orderby value to set.
      Returns:
      the QueryOptions object itself.

    • getFilter

      public com.azure.core.util.BinaryData getFilter()
      Get the filter property: The filter for the search. See examples for the usage of supported filters.
      Returns:
      the filter value.

    • setFilter

      public QueryOptions setFilter(com.azure.core.util.BinaryData filter)
      Set the filter property: The filter for the search. See examples for the usage of supported filters.
      Parameters:
      filter - the filter value to set.
      Returns:
      the QueryOptions object itself.

    • getFacets

      public List<SearchFacetItem> getFacets()
      Get the facets property: The facets for search. See examples for the usage of supported facets.
      Returns:
      the facets value.

    • setFacets

      public QueryOptions setFacets(List<SearchFacetItem> facets)
      Set the facets property: The facets for search. See examples for the usage of supported facets.
      Parameters:
      facets - the facets value to set.
      Returns:
      the QueryOptions object itself.

    • getTaxonomySetting

      public SearchTaxonomySetting getTaxonomySetting()
      Get the taxonomySetting property: The taxonomy setting for search.
      Returns:
      the taxonomySetting value.

    • setTaxonomySetting

      public QueryOptions setTaxonomySetting(SearchTaxonomySetting taxonomySetting)
      Set the taxonomySetting property: The taxonomy setting for search.
      Parameters:
      taxonomySetting - the taxonomySetting value to set.
      Returns:
      the QueryOptions object itself.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<QueryOptions>
      Throws:
      IOException

    • fromJson

      public static QueryOptions fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of QueryOptions from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of QueryOptions if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the QueryOptions.