Class FeatureSummary

java.lang.Object
software.amazon.awssdk.services.evidently.model.FeatureSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FeatureSummary.Builder,FeatureSummary>
@Generated("software.amazon.awssdk:codegen") public final class FeatureSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FeatureSummary.Builder,FeatureSummary>

This structure contains information about one Evidently feature in your account.

See Also:

  • Method Details

    • arn

      public final String arn()

      The ARN of the feature.

      Returns:
      The ARN of the feature.

    • createdTime

      public final Instant createdTime()

      The date and time that the feature is created.

      Returns:
      The date and time that the feature is created.

    • defaultVariation

      public final String defaultVariation()

      The name of the variation that is used as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

      Returns:
      The name of the variation that is used as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature.

    • hasEvaluationRules

      public final boolean hasEvaluationRules()
      For responses, this returns true if the service returned a value for the EvaluationRules 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.

    • evaluationRules

      public final List<EvaluationRule> evaluationRules()

      An array of structures that define

      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 hasEvaluationRules() method.

      Returns:
      An array of structures that define

    • evaluationStrategy

      public final FeatureEvaluationStrategy evaluationStrategy()

      If this value is ALL_RULES, the traffic allocation specified by any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION, the default variation is being served to all users.

      If the service returns an enum value that is not available in the current SDK version, evaluationStrategy will return FeatureEvaluationStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from evaluationStrategyAsString().

      Returns:
      If this value is ALL_RULES, the traffic allocation specified by any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION, the default variation is being served to all users.
      See Also:

    • evaluationStrategyAsString

      public final String evaluationStrategyAsString()

      If this value is ALL_RULES, the traffic allocation specified by any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION, the default variation is being served to all users.

      If the service returns an enum value that is not available in the current SDK version, evaluationStrategy will return FeatureEvaluationStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from evaluationStrategyAsString().

      Returns:
      If this value is ALL_RULES, the traffic allocation specified by any ongoing launches or experiments is being used. If this is DEFAULT_VARIATION, the default variation is being served to all users.
      See Also:

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

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

      Returns:
      The date and time that the feature was most recently updated.

    • name

      public final String name()

      The name of the feature.

      Returns:
      The name of the feature.

    • project

      public final String project()

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

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

    • status

      public final FeatureStatus status()

      The current state of the feature.

      If the service returns an enum value that is not available in the current SDK version, status will return FeatureStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current state of the feature.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current state of the feature.

      If the service returns an enum value that is not available in the current SDK version, status will return FeatureStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current state of the feature.
      See Also:

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

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

    • toBuilder

      public FeatureSummary.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<FeatureSummary.Builder,FeatureSummary>
      Returns:
      a builder for type T

    • builder

      public static FeatureSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FeatureSummary.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)
      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)

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.