Class ExperimentReport

java.lang.Object
software.amazon.awssdk.services.evidently.model.ExperimentReport
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ExperimentReport.Builder,ExperimentReport>
@Generated("software.amazon.awssdk:codegen") public final class ExperimentReport extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ExperimentReport.Builder,ExperimentReport>

A structure that contains results of an experiment.

See Also:

  • Method Details

    • content

      public final String content()

      The content of the report.

      Returns:
      The content of the report.

    • metricName

      public final String metricName()

      The name of the metric that is analyzed in this experiment report.

      Returns:
      The name of the metric that is analyzed in this experiment report.

    • reportName

      public final ExperimentReportName reportName()

      The type of analysis used for this report.

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

      Returns:
      The type of analysis used for this report.
      See Also:

    • reportNameAsString

      public final String reportNameAsString()

      The type of analysis used for this report.

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

      Returns:
      The type of analysis used for this report.
      See Also:

    • treatmentName

      public final String treatmentName()

      The name of the variation that this report pertains to.

      Returns:
      The name of the variation that this report pertains to.

    • toBuilder

      public ExperimentReport.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<ExperimentReport.Builder,ExperimentReport>
      Returns:
      a builder for type T

    • builder

      public static ExperimentReport.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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