Class ListEntitiesOptions


  • public final class ListEntitiesOptions
    extends Object
    Options to modify the data returned from the listEntities family of methods.
    • Constructor Detail

      • ListEntitiesOptions

        public ListEntitiesOptions()
    • Method Detail

      • getTop

        public Integer getTop()
        Gets the value of the `top` OData query option which limits the number of returned entities.
        Returns:
        The value of the `top` OData query option.
      • setTop

        public ListEntitiesOptions setTop​(Integer top)
        Sets the value of the `top` OData query option which limits the number of returned entities.
        Parameters:
        top - The value of the `top` OData query option.
        Returns:
        The updated ListEntitiesOptions.
      • getSelect

        public List<String> getSelect()
        Gets a list of properties to select on each entity.
        Returns:
        The list of properties to select on each entity.
      • setSelect

        public ListEntitiesOptions setSelect​(List<String> select)
        Sets a list of properties to select on each entity.
        Parameters:
        select - The list of properties to select on each entity.
        Returns:
        The updated ListEntitiesOptions.
      • getFilter

        public String getFilter()
        Gets the value of the `filter` OData query option which filters the set of returned entities, excluding those that do not match the filter expression.
        Returns:
        The value of the `filter` OData query option.
      • setFilter

        public ListEntitiesOptions setFilter​(String filter)
        Sets the value of the `filter` OData query option which filters the set of returned entities, excluding those that do not match the filter expression.
        Parameters:
        filter - The value of the `filter` OData query option.
        Returns:
        The updated ListEntitiesOptions.