Package software.amazon.awssdk.services.chimesdkmediapipelines.model

Class KeywordMatchConfiguration

java.lang.Object

software.amazon.awssdk.services.chimesdkmediapipelines.model.KeywordMatchConfiguration

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class KeywordMatchConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<KeywordMatchConfiguration.Builder,KeywordMatchConfiguration>

A structure that contains the settings for a keyword match task.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KeywordMatchConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static KeywordMatchConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasKeywords()	For responses, this returns true if the service returned a value for the Keywords property.
List<String>	keywords()	The keywords or phrases that you want to match.
Boolean	negate()	Matches keywords or phrases on their presence or absence.
String	ruleName()	The name of the keyword match rule.
List<SdkField<?>>	sdkFields()
static Class<? extends KeywordMatchConfiguration.Builder>	serializableBuilderClass()
KeywordMatchConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

ruleName

public final String ruleName()

The name of the keyword match rule.

Returns:

The name of the keyword match rule.

hasKeywords

public final boolean hasKeywords()

For responses, this returns true if the service returned a value for the Keywords 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.

keywords

public final List<String> keywords()

The keywords or phrases that you want to match.

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

Returns:

The keywords or phrases that you want to match.

negate

public final Boolean negate()

Matches keywords or phrases on their presence or absence. If set to TRUE, the rule matches when all the specified keywords or phrases are absent. Default: FALSE.

Returns:

Matches keywords or phrases on their presence or absence. If set to TRUE, the rule matches when all the specified keywords or phrases are absent. Default: FALSE.

toBuilder

public KeywordMatchConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KeywordMatchConfiguration.Builder,KeywordMatchConfiguration>

builder

public static KeywordMatchConfiguration.Builder builder()

serializableBuilderClass

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