Class GetExperimentResultsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.evidently.model.EvidentlyRequest
software.amazon.awssdk.services.evidently.model.GetExperimentResultsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetExperimentResultsRequest.Builder,GetExperimentResultsRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetExperimentResultsRequest extends EvidentlyRequest implements ToCopyableBuilder<GetExperimentResultsRequest.Builder,GetExperimentResultsRequest>

  • Method Details

    • 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:

    • 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:

    • 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.

    • toBuilder

      public GetExperimentResultsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetExperimentResultsRequest.Builder,GetExperimentResultsRequest>
      Specified by:
      toBuilder in class EvidentlyRequest
      Returns:
      a builder for type T

    • builder

      public static GetExperimentResultsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetExperimentResultsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.