Class RecommendationTrigger

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

A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in recommendationIds by a single RecommendationTrigger.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of the recommendation trigger.

      Returns:
      The identifier of the recommendation trigger.

    • type

      public final RecommendationTriggerType type()

      The type of recommendation trigger.

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

      Returns:
      The type of recommendation trigger.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of recommendation trigger.

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

      Returns:
      The type of recommendation trigger.
      See Also:

    • source

      public final RecommendationSourceType source()

      The source of the recommendation trigger.

      • ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.

      • RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.

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

      Returns:
      The source of the recommendation trigger.

      • ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.

      • RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.

      See Also:

    • sourceAsString

      public final String sourceAsString()

      The source of the recommendation trigger.

      • ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.

      • RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.

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

      Returns:
      The source of the recommendation trigger.

      • ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.

      • RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.

      See Also:

    • data

      public final RecommendationTriggerData data()

      A union type containing information related to the trigger.

      Returns:
      A union type containing information related to the trigger.

    • hasRecommendationIds

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

    • recommendationIds

      public final List<String> recommendationIds()

      The identifiers of the recommendations.

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

      Returns:
      The identifiers of the recommendations.

    • toBuilder

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

    • builder

      public static RecommendationTrigger.Builder builder()

    • serializableBuilderClass

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