Package software.amazon.awssdk.services.evidently.model

Class GetExperimentResultsRequest

    • Method Detail

      • baseStat

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, baseStat will return ExperimentBaseStat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from baseStatAsString().

        Returns:
        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.
        See Also:
        ExperimentBaseStat

      • baseStatAsString

        public final String baseStatAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, baseStat will return ExperimentBaseStat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from baseStatAsString().

        Returns:
        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.
        See Also:
        ExperimentBaseStat

      • endTime

        public final 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.

        Returns:
        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.

      • experiment

        public final String experiment()

        The name of the experiment to retrieve the results of.

        Returns:
        The name of the experiment to retrieve the results of.

      • hasMetricNames

        public final boolean hasMetricNames()
        For responses, this returns true if the service returned a value for the MetricNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • metricNames

        public final List<String> metricNames()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetricNames() method.

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

      • period

        public final Long period()

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

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

      • project

        public final String project()

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

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

      • reportNames

        public final List<ExperimentReportName> reportNames()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReportNames() method.

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

      • hasReportNames

        public final boolean hasReportNames()
        For responses, this returns true if the service returned a value for the ReportNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • reportNamesAsStrings

        public final List<String> reportNamesAsStrings()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReportNames() method.

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

      • resultStats

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResultStats() method.

        Returns:
        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.

      • hasResultStats

        public final boolean hasResultStats()
        For responses, this returns true if the service returned a value for the ResultStats property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • resultStatsAsStrings

        public final List<String> resultStatsAsStrings()

        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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResultStats() method.

        Returns:
        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.

      • startTime

        public final Instant startTime()

        The date and time that the experiment started.

        Returns:
        The date and time that the experiment started.

      • hasTreatmentNames

        public final boolean hasTreatmentNames()
        For responses, this returns true if the service returned a value for the TreatmentNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • treatmentNames

        public final List<String> treatmentNames()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTreatmentNames() method.

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

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object