software.amazon.awssdk.services.wisdom.model

Class RecommendationTrigger

java.lang.Object

software.amazon.awssdk.services.wisdom.model.RecommendationTrigger

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RecommendationTrigger.Builder,RecommendationTrigger>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RecommendationTrigger.Builder

Method Summary

Modifier and Type	Method and Description
static RecommendationTrigger.Builder	builder()
RecommendationTriggerData	data() A union type containing information related to the trigger.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRecommendationIds() For responses, this returns true if the service returned a value for the RecommendationIds property.
String	id() The identifier of the recommendation trigger.
List<String>	recommendationIds() The identifiers of the recommendations.
List<SdkField<?>>	sdkFields()
static Class<? extends RecommendationTrigger.Builder>	serializableBuilderClass()
RecommendationSourceType	source() The source of the recommendation trigger.
String	sourceAsString() The source of the recommendation trigger.
RecommendationTrigger.Builder	toBuilder()
String	toString() Returns a string representation of this object.
RecommendationTriggerType	type() The type of recommendation trigger.
String	typeAsString() The type of recommendation trigger.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

data

public final RecommendationTriggerData data()

A union type containing information related to the trigger.

Returns:

A union type containing information related to the trigger.

id

public final String id()

The identifier of the recommendation trigger.

Returns:

The identifier of the recommendation 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.

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:

RecommendationSourceType

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:

RecommendationSourceType

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:

RecommendationTriggerType

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:

RecommendationTriggerType

toBuilder

public RecommendationTrigger.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RecommendationTrigger.Builder,RecommendationTrigger>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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