Interface GetExperimentResultsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetExperimentResultsRequest.Builder,GetExperimentResultsRequest>, EvidentlyRequest.Builder, SdkBuilder<GetExperimentResultsRequest.Builder,GetExperimentResultsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetExperimentResultsRequest
@Mutable @NotThreadSafe public static interface GetExperimentResultsRequest.Builder extends EvidentlyRequest.Builder, SdkPojo, CopyableBuilder<GetExperimentResultsRequest.Builder,GetExperimentResultsRequest>

  • Method Details

    • baseStat

      GetExperimentResultsRequest.Builder baseStat(String baseStat)

      The statistic used to calculate experiment results. Currently the only valid value is mean, which uses the mean of the collected values as the statistic.

      Parameters:
      baseStat - The statistic used to calculate experiment results. Currently the only valid value is mean, which uses the mean of the collected values as the statistic.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • baseStat

      GetExperimentResultsRequest.Builder baseStat(ExperimentBaseStat baseStat)

      The statistic used to calculate experiment results. Currently the only valid value is mean, which uses the mean of the collected values as the statistic.

      Parameters:
      baseStat - The statistic used to calculate experiment results. Currently the only valid value is mean, which uses the mean of the collected values as the statistic.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • endTime

      GetExperimentResultsRequest.Builder endTime(Instant endTime)

      The date and time that the experiment ended, if it is completed. This must be no longer than 30 days after the experiment start time.

      Parameters:
      endTime - The date and time that the experiment ended, if it is completed. This must be no longer than 30 days after the experiment start time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • experiment

      GetExperimentResultsRequest.Builder experiment(String experiment)

      The name of the experiment to retrieve the results of.

      Parameters:
      experiment - The name of the experiment to retrieve the results of.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricNames

      GetExperimentResultsRequest.Builder metricNames(Collection<String> metricNames)

      The names of the experiment metrics that you want to see the results of.

      Parameters:
      metricNames - The names of the experiment metrics that you want to see the results of.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricNames

      GetExperimentResultsRequest.Builder metricNames(String... metricNames)

      The names of the experiment metrics that you want to see the results of.

      Parameters:
      metricNames - The names of the experiment metrics that you want to see the results of.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • period

      GetExperimentResultsRequest.Builder period(Long period)

      In seconds, the amount of time to aggregate results together.

      Parameters:
      period - In seconds, the amount of time to aggregate results together.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • project

      GetExperimentResultsRequest.Builder project(String project)

      The name or ARN of the project that contains the experiment that you want to see the results of.

      Parameters:
      project - The name or ARN of the project that contains the experiment that you want to see the results of.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reportNamesWithStrings

      GetExperimentResultsRequest.Builder reportNamesWithStrings(Collection<String> reportNames)

      The names of the report types that you want to see. Currently, BayesianInference is the only valid value.

      Parameters:
      reportNames - The names of the report types that you want to see. Currently, BayesianInference is the only valid value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reportNamesWithStrings

      GetExperimentResultsRequest.Builder reportNamesWithStrings(String... reportNames)

      The names of the report types that you want to see. Currently, BayesianInference is the only valid value.

      Parameters:
      reportNames - The names of the report types that you want to see. Currently, BayesianInference is the only valid value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reportNames

      GetExperimentResultsRequest.Builder reportNames(Collection<ExperimentReportName> reportNames)

      The names of the report types that you want to see. Currently, BayesianInference is the only valid value.

      Parameters:
      reportNames - The names of the report types that you want to see. Currently, BayesianInference is the only valid value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reportNames

      GetExperimentResultsRequest.Builder reportNames(ExperimentReportName... reportNames)

      The names of the report types that you want to see. Currently, BayesianInference is the only valid value.

      Parameters:
      reportNames - The names of the report types that you want to see. Currently, BayesianInference is the only valid value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resultStatsWithStrings

      GetExperimentResultsRequest.Builder resultStatsWithStrings(Collection<String> resultStats)

      The statistics that you want to see in the returned results.

      • PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

      • ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

      • TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.

      • BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

      Parameters:
      resultStats - The statistics that you want to see in the returned results.

      • PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

      • ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

      • TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.

      • BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resultStatsWithStrings

      GetExperimentResultsRequest.Builder resultStatsWithStrings(String... resultStats)

      The statistics that you want to see in the returned results.

      • PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

      • ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

      • TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.

      • BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

      Parameters:
      resultStats - The statistics that you want to see in the returned results.

      • PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

      • ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

      • TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.

      • BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resultStats

      GetExperimentResultsRequest.Builder resultStats(Collection<ExperimentResultRequestType> resultStats)

      The statistics that you want to see in the returned results.

      • PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

      • ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

      • TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.

      • BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

      Parameters:
      resultStats - The statistics that you want to see in the returned results.

      • PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

      • ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

      • TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.

      • BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resultStats

      GetExperimentResultsRequest.Builder resultStats(ExperimentResultRequestType... resultStats)

      The statistics that you want to see in the returned results.

      • PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

      • ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

      • TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.

      • BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

      Parameters:
      resultStats - The statistics that you want to see in the returned results.

      • PValue specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.

      • ConfidenceInterval specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the baseStat of a variation and the baseline. Evidently returns the 95% confidence interval.

      • TreatmentEffect is the difference in the statistic specified by the baseStat parameter between each variation and the default variation.

      • BaseStat returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the baseStat parameter. Therefore, if baseStat is mean, this returns the mean of the values collected for each variation.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTime

      GetExperimentResultsRequest.Builder startTime(Instant startTime)

      The date and time that the experiment started.

      Parameters:
      startTime - The date and time that the experiment started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • treatmentNames

      GetExperimentResultsRequest.Builder treatmentNames(Collection<String> treatmentNames)

      The names of the experiment treatments that you want to see the results for.

      Parameters:
      treatmentNames - The names of the experiment treatments that you want to see the results for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • treatmentNames

      GetExperimentResultsRequest.Builder treatmentNames(String... treatmentNames)

      The names of the experiment treatments that you want to see the results for.

      Parameters:
      treatmentNames - The names of the experiment treatments that you want to see the results for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetExperimentResultsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetExperimentResultsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.