Interface GetExperimentDefinitionResponse.Builder

All Superinterfaces:
AppConfigResponse.Builder, AwsResponse.Builder, Buildable, CopyableBuilder<GetExperimentDefinitionResponse.Builder,GetExperimentDefinitionResponse>, SdkBuilder<GetExperimentDefinitionResponse.Builder,GetExperimentDefinitionResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetExperimentDefinitionResponse
@Mutable @NotThreadSafe public static interface GetExperimentDefinitionResponse.Builder extends AppConfigResponse.Builder, SdkPojo, CopyableBuilder<GetExperimentDefinitionResponse.Builder,GetExperimentDefinitionResponse>

  • Method Details

    • applicationId

      GetExperimentDefinitionResponse.Builder applicationId(String applicationId)

      The application ID.

      Parameters:
      applicationId - The application ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • id

      GetExperimentDefinitionResponse.Builder id(String id)

      The experiment definition ID.

      Parameters:
      id - The experiment definition ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      GetExperimentDefinitionResponse.Builder name(String name)

      The name of the experiment definition.

      Parameters:
      name - The name of the experiment definition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hypothesis

      GetExperimentDefinitionResponse.Builder hypothesis(String hypothesis)

      The hypothesis that the experiment is designed to validate.

      Parameters:
      hypothesis - The hypothesis that the experiment is designed to validate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      GetExperimentDefinitionResponse.Builder status(String status)

      The current status of the experiment definition. Valid values: ACTIVE, IDLE, ARCHIVED.

      Parameters:
      status - The current status of the experiment definition. Valid values: ACTIVE, IDLE, ARCHIVED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetExperimentDefinitionResponse.Builder status(ExperimentDefinitionStatus status)

      The current status of the experiment definition. Valid values: ACTIVE, IDLE, ARCHIVED.

      Parameters:
      status - The current status of the experiment definition. Valid values: ACTIVE, IDLE, ARCHIVED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • configurationProfileId

      GetExperimentDefinitionResponse.Builder configurationProfileId(String configurationProfileId)

      The configuration profile ID associated with the experiment.

      Parameters:
      configurationProfileId - The configuration profile ID associated with the experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • environmentId

      GetExperimentDefinitionResponse.Builder environmentId(String environmentId)

      The environment ID where the experiment runs.

      Parameters:
      environmentId - The environment ID where the experiment runs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • flagKey

      GetExperimentDefinitionResponse.Builder flagKey(String flagKey)

      The key of the feature flag used by the experiment.

      Parameters:
      flagKey - The key of the feature flag used by the experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • audienceRule

      GetExperimentDefinitionResponse.Builder audienceRule(String audienceRule)

      The rule that defines which users are eligible to be assigned to treatments.

      Parameters:
      audienceRule - The rule that defines which users are eligible to be assigned to treatments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • audienceDescription

      GetExperimentDefinitionResponse.Builder audienceDescription(String audienceDescription)

      A description of the intended audience for the experiment.

      Parameters:
      audienceDescription - A description of the intended audience for the experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • launchCriteria

      GetExperimentDefinitionResponse.Builder launchCriteria(String launchCriteria)

      The conditions under which the winning treatment should be launched.

      Parameters:
      launchCriteria - The conditions under which the winning treatment should be launched.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • treatments

      GetExperimentDefinitionResponse.Builder treatments(Collection<Treatment> treatments)

      The list of treatments defined for the experiment.

      Parameters:
      treatments - The list of treatments defined for the experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • treatments

      GetExperimentDefinitionResponse.Builder treatments(Treatment... treatments)

      The list of treatments defined for the experiment.

      Parameters:
      treatments - The list of treatments defined for the experiment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • treatments

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

      The list of treatments defined for 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<Treatment>).

      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:

    • control

      GetExperimentDefinitionResponse.Builder control(Treatment control)

      The control treatment used as the baseline for comparison.

      Parameters:
      control - The control treatment used as the baseline for comparison.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • control

      default GetExperimentDefinitionResponse.Builder control(Consumer<Treatment.Builder> control)

      The control treatment used as the baseline for comparison.

      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 control(Treatment).

      Parameters:
      control - 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:

    • createdAt

      GetExperimentDefinitionResponse.Builder createdAt(Instant createdAt)

      The date and time the experiment definition was created, in ISO 8601 format.

      Parameters:
      createdAt - The date and time the experiment definition was created, in ISO 8601 format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      GetExperimentDefinitionResponse.Builder updatedAt(Instant updatedAt)

      The date and time the experiment definition was last updated, in ISO 8601 format.

      Parameters:
      updatedAt - The date and time the experiment definition was last updated, in ISO 8601 format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyIdentifier

      GetExperimentDefinitionResponse.Builder kmsKeyIdentifier(String kmsKeyIdentifier)

      The Amazon Resource Name (ARN) of the KMS key used to encrypt experiment data.

      Parameters:
      kmsKeyIdentifier - The Amazon Resource Name (ARN) of the KMS key used to encrypt experiment data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.