Package com.algolia.model.abtesting

Class Variant

java.lang.Object
com.algolia.model.abtesting.Variant
public class Variant extends Object
Variant

  • Constructor Details

    • Variant

      public Variant()

  • Method Details

    • setAverageClickPosition

      public Variant setAverageClickPosition(Integer averageClickPosition)

    • getAverageClickPosition

      @Nonnull public Integer getAverageClickPosition()
      Variant's [average click position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position).
      Returns:
      averageClickPosition

    • setClickCount

      public Variant setClickCount(Integer clickCount)

    • getClickCount

      @Nonnull public Integer getClickCount()
      Number of click events for this variant.
      Returns:
      clickCount

    • setClickThroughRate

      public Variant setClickThroughRate(Double clickThroughRate)

    • getClickThroughRate

      @Nonnull public Double getClickThroughRate()
      Variant's [click-through rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
      Returns:
      clickThroughRate

    • setConversionCount

      public Variant setConversionCount(Integer conversionCount)

    • getConversionCount

      @Nonnull public Integer getConversionCount()
      Number of click events for this variant.
      Returns:
      conversionCount

    • setConversionRate

      public Variant setConversionRate(Double conversionRate)

    • getConversionRate

      @Nonnull public Double getConversionRate()
      Variant's [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
      Returns:
      conversionRate

    • setDescription

      public Variant setDescription(String description)

    • getDescription

      @Nonnull public String getDescription()
      A/B test description.
      Returns:
      description

    • setIndex

      public Variant setIndex(String index)

    • getIndex

      @Nonnull public String getIndex()
      A/B test index.
      Returns:
      index

    • setNoResultCount

      public Variant setNoResultCount(Integer noResultCount)

    • getNoResultCount

      @Nonnull public Integer getNoResultCount()
      Number of [searches without results](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#searches-without-results) for that variant.
      Returns:
      noResultCount

    • setOutlierTrackedSearchesCount

      public Variant setOutlierTrackedSearchesCount(Integer outlierTrackedSearchesCount)

    • getOutlierTrackedSearchesCount

      @Nonnull public Integer getOutlierTrackedSearchesCount()
      Number of tracked searches attributed to [outlier traffic](https://www.algolia.com/doc/guides/ab-testing/how-to-read-your-a-b-test-results/#is-the-split-off) that were removed from the A/B test. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
      Returns:
      outlierTrackedSearchesCount

    • setOutlierUsersCount

      public Variant setOutlierUsersCount(Integer outlierUsersCount)

    • getOutlierUsersCount

      @Nonnull public Integer getOutlierUsersCount()
      Number of users attributed to [outlier traffic](https://www.algolia.com/doc/guides/ab-testing/how-to-read-your-a-b-test-results/#is-the-split-off) that were removed from the A/B test.
      Returns:
      outlierUsersCount

    • setSearchCount

      public Variant setSearchCount(Integer searchCount)

    • getSearchCount

      @Nonnull public Integer getSearchCount()
      Number of searches carried out during the A/B test.
      Returns:
      searchCount

    • setTrackedSearchCount

      public Variant setTrackedSearchCount(Integer trackedSearchCount)

    • getTrackedSearchCount

      @Nonnull public Integer getTrackedSearchCount()
      Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
      Returns:
      trackedSearchCount

    • setTrafficPercentage

      public Variant setTrafficPercentage(Integer trafficPercentage)

    • getTrafficPercentage

      @Nonnull public Integer getTrafficPercentage()
      A/B test traffic percentage.
      Returns:
      trafficPercentage

    • setUserCount

      public Variant setUserCount(Integer userCount)

    • getUserCount

      @Nonnull public Integer getUserCount()
      Number of users during the A/B test.
      Returns:
      userCount

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object