software.amazon.awssdk.services.evidently.model

Interface Experiment.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Experiment.Builder,Experiment>, SdkBuilder<Experiment.Builder,Experiment>, SdkPojo

Enclosing class:

Experiment

public static interface Experiment.Builder
extends SdkPojo, CopyableBuilder<Experiment.Builder,Experiment>

Method Summary

Modifier and Type	Method and Description
Experiment.Builder	arn(String arn) The ARN of the experiment.
Experiment.Builder	createdTime(Instant createdTime) The date and time that the experiment is first created.
Experiment.Builder	description(String description) A description of the experiment.
default Experiment.Builder	execution(Consumer<ExperimentExecution.Builder> execution) A structure that contains the date and time that the experiment started and ended.
Experiment.Builder	execution(ExperimentExecution execution) A structure that contains the date and time that the experiment started and ended.
Experiment.Builder	lastUpdatedTime(Instant lastUpdatedTime) The date and time that the experiment was most recently updated.
Experiment.Builder	metricGoals(Collection<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.
Experiment.Builder	metricGoals(Consumer<MetricGoal.Builder>... 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.
Experiment.Builder	metricGoals(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.
Experiment.Builder	name(String name) The name of the experiment.
default Experiment.Builder	onlineAbDefinition(Consumer<OnlineAbDefinition.Builder> onlineAbDefinition) A structure that contains the configuration of which variation to use as the "control" version.
Experiment.Builder	onlineAbDefinition(OnlineAbDefinition onlineAbDefinition) A structure that contains the configuration of which variation to use as the "control" version.
Experiment.Builder	project(String project) The name or ARN of the project that contains this experiment.
Experiment.Builder	randomizationSalt(String randomizationSalt) This value is used when Evidently assigns a particular user session to the experiment.
Experiment.Builder	samplingRate(Long samplingRate) In thousandths of a percent, the amount of the available audience that is allocated to this experiment.
default Experiment.Builder	schedule(Consumer<ExperimentSchedule.Builder> schedule) A structure that contains the time and date that Evidently completed the analysis of the experiment.
Experiment.Builder	schedule(ExperimentSchedule schedule) A structure that contains the time and date that Evidently completed the analysis of the experiment.
Experiment.Builder	segment(String segment) The audience segment being used for the experiment, if a segment is being used.
Experiment.Builder	status(ExperimentStatus status) The current state of the experiment.
Experiment.Builder	status(String status) The current state of the experiment.
Experiment.Builder	statusReason(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.
Experiment.Builder	tags(Map<String,String> tags) The list of tag keys and values associated with this experiment.
Experiment.Builder	treatments(Collection<Treatment> treatments) An array of structures that describe the configuration of each feature variation used in the experiment.
Experiment.Builder	treatments(Consumer<Treatment.Builder>... treatments) An array of structures that describe the configuration of each feature variation used in the experiment.
Experiment.Builder	treatments(Treatment... treatments) An array of structures that describe the configuration of each feature variation used in the experiment.
Experiment.Builder	type(ExperimentType type) The type of this experiment.
Experiment.Builder	type(String type) The type of this experiment.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

arn

Experiment.Builder arn(String arn)

The ARN of the experiment.

Parameters:

arn - The ARN of the experiment.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdTime

Experiment.Builder createdTime(Instant createdTime)

The date and time that the experiment is first created.

Parameters:

createdTime - The date and time that the experiment is first created.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

Experiment.Builder description(String description)

A description of the experiment.

Parameters:

description - A description of the experiment.

Returns:

Returns a reference to this object so that method calls can be chained together.

execution

Experiment.Builder execution(ExperimentExecution execution)

A structure that contains the date and time that the experiment started and ended.

Parameters:

execution - A structure that contains the date and time that the experiment started and ended.

Returns:

Returns a reference to this object so that method calls can be chained together.

execution

default Experiment.Builder execution(Consumer<ExperimentExecution.Builder> execution)

A structure that contains the date and time that the experiment started and ended.

This is a convenience method that creates an instance of the ExperimentExecution.Builder avoiding the need to create one manually via ExperimentExecution.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to execution(ExperimentExecution).

Parameters:

execution - a consumer that will call methods on ExperimentExecution.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

execution(ExperimentExecution)

lastUpdatedTime

Experiment.Builder lastUpdatedTime(Instant lastUpdatedTime)

The date and time that the experiment was most recently updated.

Parameters:

lastUpdatedTime - The date and time that the experiment was most recently updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

metricGoals

Experiment.Builder metricGoals(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

metricGoals

Experiment.Builder metricGoals(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

metricGoals

Experiment.Builder metricGoals(Consumer<MetricGoal.Builder>... 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.

This is a convenience method that creates an instance of the MetricGoal.Builder avoiding the need to create one manually via MetricGoal.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #metricGoals(List).

Parameters:

metricGoals - a consumer that will call methods on MetricGoal.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#metricGoals(java.util.Collection)

name

Experiment.Builder name(String name)

The name of the experiment.

Parameters:

name - The name of the experiment.

Returns:

Returns a reference to this object so that method calls can be chained together.

onlineAbDefinition

Experiment.Builder onlineAbDefinition(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

onlineAbDefinition

default Experiment.Builder onlineAbDefinition(Consumer<OnlineAbDefinition.Builder> 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.

This is a convenience method that creates an instance of the OnlineAbDefinition.Builder avoiding the need to create one manually via OnlineAbDefinition.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to onlineAbDefinition(OnlineAbDefinition).

Parameters:

onlineAbDefinition - a consumer that will call methods on OnlineAbDefinition.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

onlineAbDefinition(OnlineAbDefinition)

project

Experiment.Builder project(String project)

The name or ARN of the project that contains this experiment.

Parameters:

project - The name or ARN of the project that contains this experiment.

Returns:

Returns a reference to this object so that method calls can be chained together.

randomizationSalt

Experiment.Builder randomizationSalt(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

samplingRate

Experiment.Builder samplingRate(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

schedule

Experiment.Builder schedule(ExperimentSchedule schedule)

A structure that contains the time and date that Evidently completed the analysis of the experiment.

Parameters:

schedule - A structure that contains the time and date that Evidently completed the analysis of the experiment.

Returns:

Returns a reference to this object so that method calls can be chained together.

schedule

default Experiment.Builder schedule(Consumer<ExperimentSchedule.Builder> schedule)

A structure that contains the time and date that Evidently completed the analysis of the experiment.

This is a convenience method that creates an instance of the ExperimentSchedule.Builder avoiding the need to create one manually via ExperimentSchedule.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schedule(ExperimentSchedule).

Parameters:

schedule - a consumer that will call methods on ExperimentSchedule.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

schedule(ExperimentSchedule)

segment

Experiment.Builder segment(String segment)

The audience segment being used for the experiment, if a segment is being used.

Parameters:

segment - The audience segment being used for the experiment, if a segment is being used.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

Experiment.Builder status(String status)

The current state of the experiment.

Parameters:

status - The current state of the experiment.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ExperimentStatus, ExperimentStatus

status

Experiment.Builder status(ExperimentStatus status)

The current state of the experiment.

Parameters:

status - The current state of the experiment.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ExperimentStatus, ExperimentStatus

statusReason

Experiment.Builder statusReason(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

tags

Experiment.Builder tags(Map<String,String> tags)

The list of tag keys and values associated with this experiment.

Parameters:

tags - The list of tag keys and values associated with this experiment.

Returns:

Returns a reference to this object so that method calls can be chained together.

treatments

Experiment.Builder treatments(Collection<Treatment> treatments)

An array of structures that describe the configuration of each feature variation used in the experiment.

Parameters:

treatments - An array of structures that describe the configuration of each feature variation used in the experiment.

Returns:

Returns a reference to this object so that method calls can be chained together.

treatments

Experiment.Builder treatments(Treatment... treatments)

An array of structures that describe the configuration of each feature variation used in the experiment.

Parameters:

treatments - An array of structures that describe the configuration of each feature variation used in the experiment.

Returns:

Returns a reference to this object so that method calls can be chained together.

treatments

Experiment.Builder treatments(Consumer<Treatment.Builder>... treatments)

An array of structures that describe the configuration of each feature variation used in the experiment.

This is a convenience method that creates an instance of the Treatment.Builder avoiding the need to create one manually via Treatment.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #treatments(List).

Parameters:

treatments - a consumer that will call methods on Treatment.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#treatments(java.util.Collection)

type

Experiment.Builder type(String type)

The type of this experiment. Currently, this value must be aws.experiment.onlineab.

Parameters:

type - The type of this experiment. Currently, this value must be aws.experiment.onlineab.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ExperimentType, ExperimentType

type

Experiment.Builder type(ExperimentType type)

The type of this experiment. Currently, this value must be aws.experiment.onlineab.

Parameters:

type - The type of this experiment. Currently, this value must be aws.experiment.onlineab.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ExperimentType, ExperimentType