Class EvaluateFeatureRequest

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.EvaluateFeatureRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<EvaluateFeatureRequest.Builder,EvaluateFeatureRequest>
@Generated("software.amazon.awssdk:codegen") public final class EvaluateFeatureRequest extends EvidentlyRequest implements ToCopyableBuilder<EvaluateFeatureRequest.Builder,EvaluateFeatureRequest>

  • Method Details

    • entityId

      public final String entityId()

      An internal ID that represents a unique user of the application. This entityID is checked against any override rules assigned for this feature.

      Returns:
      An internal ID that represents a unique user of the application. This entityID is checked against any override rules assigned for this feature.

    • evaluationContext

      public final String evaluationContext()

      A JSON object of attributes that you can optionally pass in as part of the evaluation event sent to Evidently from the user session. Evidently can use this value to match user sessions with defined audience segments. For more information, see Use segments to focus your audience.

      If you include this parameter, the value must be a JSON object. A JSON array is not supported.

      Returns:
      A JSON object of attributes that you can optionally pass in as part of the evaluation event sent to Evidently from the user session. Evidently can use this value to match user sessions with defined audience segments. For more information, see Use segments to focus your audience.

      If you include this parameter, the value must be a JSON object. A JSON array is not supported.

    • feature

      public final String feature()

      The name of the feature being evaluated.

      Returns:
      The name of the feature being evaluated.

    • project

      public final String project()

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

      Returns:
      The name or ARN of the project that contains this feature.

    • toBuilder

      public EvaluateFeatureRequest.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<EvaluateFeatureRequest.Builder,EvaluateFeatureRequest>
      Specified by:
      toBuilder in class EvidentlyRequest
      Returns:
      a builder for type T

    • builder

      public static EvaluateFeatureRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EvaluateFeatureRequest.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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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