Experiment (AWS Java SDK :: Services :: Evidently 2.18.21 API)

java.lang.Object
- software.amazon.awssdk.services.evidently.model.Experiment

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Experiment.Builder,Experiment>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Experiment
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Experiment.Builder,Experiment>
```
A structure containing the configuration details of an experiment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Experiment.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Experiment.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The ARN of the experiment.
`static Experiment.Builder`	`builder()`
`Instant`	`createdTime()` The date and time that the experiment is first created.
`String`	`description()` A description of the experiment.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`ExperimentExecution`	`execution()` A structure that contains the date and time that the experiment started and ended.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasMetricGoals()` For responses, this returns true if the service returned a value for the MetricGoals property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`boolean`	`hasTreatments()` For responses, this returns true if the service returned a value for the Treatments property.
`Instant`	`lastUpdatedTime()` The date and time that the experiment was most recently updated.
`List<MetricGoal>`	`metricGoals()` An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.
`String`	`name()` The name of the experiment.
`OnlineAbDefinition`	`onlineAbDefinition()` A structure that contains the configuration of which variation to use as the "control" version.
`String`	`project()` The name or ARN of the project that contains this experiment.
`String`	`randomizationSalt()` This value is used when Evidently assigns a particular user session to the experiment.
`Long`	`samplingRate()` In thousandths of a percent, the amount of the available audience that is allocated to this experiment.
`ExperimentSchedule`	`schedule()` A structure that contains the time and date that Evidently completed the analysis of the experiment.
`List<SdkField<?>>`	`sdkFields()`
`String`	`segment()` The audience segment being used for the experiment, if a segment is being used.
`static Class<? extends Experiment.Builder>`	`serializableBuilderClass()`
`ExperimentStatus`	`status()` The current state of the experiment.
`String`	`statusAsString()` The current state of the experiment.
`String`	`statusReason()` If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.
`Map<String,String>`	`tags()` The list of tag keys and values associated with this experiment.
`Experiment.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<Treatment>`	`treatments()` An array of structures that describe the configuration of each feature variation used in the experiment.
`ExperimentType`	`type()` The type of this experiment.
`String`	`typeAsString()` The type of this experiment.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - arn
```
public final String arn()
```
    The ARN of the experiment.
    
    Returns:
    
    The ARN of the experiment.
  - createdTime
```
public final Instant createdTime()
```
    The date and time that the experiment is first created.
    
    Returns:
    
    The date and time that the experiment is first created.
  - description
```
public final String description()
```
    A description of the experiment.
    
    Returns:
    
    A description of the experiment.
  - execution
```
public final ExperimentExecution execution()
```
    A structure that contains the date and time that the experiment started and ended.
    
    Returns:
    
    A structure that contains the date and time that the experiment started and ended.
  - lastUpdatedTime
```
public final Instant lastUpdatedTime()
```
    The date and time that the experiment was most recently updated.
    
    Returns:
    
    The date and time that the experiment was most recently updated.
  - hasMetricGoals
```
public final boolean hasMetricGoals()
```
    For responses, this returns true if the service returned a value for the MetricGoals 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.
  - metricGoals
```
public final List<MetricGoal> metricGoals()
```
    An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.
    
    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 hasMetricGoals() method.
    
    Returns:
    
    An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.
  - name
```
public final String name()
```
    The name of the experiment.
    
    Returns:
    
    The name of the experiment.
  - onlineAbDefinition
```
public final OnlineAbDefinition onlineAbDefinition()
```
    A structure that contains the configuration of which variation to use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
    
    Returns:
    
    A structure that contains the configuration of which variation to use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.
  - project
```
public final String project()
```
    The name or ARN of the project that contains this experiment.
    
    Returns:
    
    The name or ARN of the project that contains this experiment.
  - randomizationSalt
```
public final String randomizationSalt()
```
    This value is used when Evidently assigns a particular user session to the experiment. It helps create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt.
    
    Returns:
    
    This value is used when Evidently assigns a particular user session to the experiment. It helps create a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt.
  - samplingRate
```
public final Long samplingRate()
```
    In thousandths of a percent, the amount of the available audience that is allocated to this experiment. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.
    
    This is represented in thousandths of a percent, so a value of 10,000 is 10% of the available audience.
    
    Returns:
    
    In thousandths of a percent, the amount of the available audience that is allocated to this experiment. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.
    
    This is represented in thousandths of a percent, so a value of 10,000 is 10% of the available audience.
  - schedule
```
public final ExperimentSchedule schedule()
```
    A structure that contains the time and date that Evidently completed the analysis of the experiment.
    
    Returns:
    
    A structure that contains the time and date that Evidently completed the analysis of the experiment.
  - segment
```
public final String segment()
```
    The audience segment being used for the experiment, if a segment is being used.
    
    Returns:
    
    The audience segment being used for the experiment, if a segment is being used.
  - status
```
public final ExperimentStatus status()
```
    The current state of the experiment.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ExperimentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current state of the experiment.
    
    See Also:
    
    ExperimentStatus
  - statusAsString
```
public final String statusAsString()
```
    The current state of the experiment.
    
    If the service returns an enum value that is not available in the current SDK version, status will return ExperimentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current state of the experiment.
    
    See Also:
    
    ExperimentStatus
  - statusReason
```
public final String statusReason()
```
    If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.
    
    Returns:
    
    If the experiment was stopped, this is the string that was entered by the person who stopped the experiment, to explain why it was stopped.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final Map<String,String> tags()
```
    The list of tag keys and values associated with this experiment.
    
    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 hasTags() method.
    
    Returns:
    
    The list of tag keys and values associated with this experiment.
  - hasTreatments
```
public final boolean hasTreatments()
```
    For responses, this returns true if the service returned a value for the Treatments 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.
  - treatments
```
public final List<Treatment> treatments()
```
    An array of structures that describe the configuration of each feature variation used in the experiment.
    
    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 hasTreatments() method.
    
    Returns:
    
    An array of structures that describe the configuration of each feature variation used in the experiment.
  - type
```
public final ExperimentType type()
```
    The type of this experiment. Currently, this value must be aws.experiment.onlineab.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ExperimentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of this experiment. Currently, this value must be aws.experiment.onlineab.
    
    See Also:
    
    ExperimentType
  - typeAsString
```
public final String typeAsString()
```
    The type of this experiment. Currently, this value must be aws.experiment.onlineab.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ExperimentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of this experiment. Currently, this value must be aws.experiment.onlineab.
    
    See Also:
    
    ExperimentType
  - toBuilder
```
public Experiment.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Experiment.Builder,Experiment>
  - builder
```
public static Experiment.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Experiment.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class Experiment

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

createdTime

description

execution

lastUpdatedTime

hasMetricGoals

metricGoals

name

onlineAbDefinition

project

randomizationSalt

samplingRate

schedule

segment

status

statusAsString

statusReason

hasTags

tags

hasTreatments

treatments

type

typeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields