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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateExperimentRequest.Builder,UpdateExperimentRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateExperimentRequest
extends EvidentlyRequest
implements ToCopyableBuilder<UpdateExperimentRequest.Builder,UpdateExperimentRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface UpdateExperimentRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static UpdateExperimentRequest.Builder`	`builder()`
`String`	`description()`	An optional description of the experiment.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`experiment()`	The name of the experiment to update.
`<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`	`hasTreatments()`	For responses, this returns true if the service returned a value for the Treatments property.
`List<MetricGoalConfig>`	`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.
`OnlineAbConfig`	`onlineAbConfig()`	A structure that contains the configuration of which variation o use as the "control" version.
`String`	`project()`	The name or ARN of the project that contains the experiment that you want to update.
`String`	`randomizationSalt()`	When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served.
`Boolean`	`removeSegment()`	Removes a segment from being used in an experiment.
`Long`	`samplingRate()`	The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`String`	`segment()`	Adds an audience segment to an experiment.
`static Class<? extends UpdateExperimentRequest.Builder>`	`serializableBuilderClass()`
`UpdateExperimentRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<TreatmentConfig>`	`treatments()`	An array of structures that define the variations being tested in the experiment.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - description
```
public final String description()
```
    An optional description of the experiment.
    
    Returns:
    
    An optional description of the experiment.
  - experiment
```
public final String experiment()
```
    The name of the experiment to update.
    
    Returns:
    
    The name of the experiment to update.
  - 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<MetricGoalConfig> 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.
  - onlineAbConfig
```
public final OnlineAbConfig onlineAbConfig()
```
    A structure that contains the configuration of which variation o 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 o 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 the experiment that you want to update.
    
    Returns:
    
    The name or ARN of the project that contains the experiment that you want to update.
  - randomizationSalt
```
public final String randomizationSalt()
```
    When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the experiment name as the randomizationSalt.
    
    Returns:
    
    When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and randomizationSalt. If you omit randomizationSalt, Evidently uses the experiment name as the randomizationSalt.
  - removeSegment
```
public final Boolean removeSegment()
```
    Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.
    
    Returns:
    
    Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.
  - samplingRate
```
public final Long samplingRate()
```
    The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. 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. For example, specify 20,000 to allocate 20% of the available audience.
    
    Returns:
    
    The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. 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. For example, specify 20,000 to allocate 20% of the available audience.
  - segment
```
public final String segment()
```
    Adds an audience segment to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.
    
    Returns:
    
    Adds an audience segment to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.
  - 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<TreatmentConfig> treatments()
```
    An array of structures that define the variations being tested 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 define the variations being tested in the experiment.
  - toBuilder
```
public UpdateExperimentRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateExperimentRequest.Builder,UpdateExperimentRequest>
    
    Specified by:
    
    toBuilder in class EvidentlyRequest
  - builder
```
public static UpdateExperimentRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateExperimentRequest.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)
```
    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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class UpdateExperimentRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

description

experiment

hasMetricGoals

metricGoals

onlineAbConfig

project

randomizationSalt

removeSegment

samplingRate

segment

hasTreatments

treatments

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField