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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Keywords property.keywords()
The keywords or phrases that you want to match.final Boolean
negate()
Matches keywords or phrases on their presence or absence.final String
ruleName()
The name of the keyword match rule.static Class
<? extends KeywordMatchConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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
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
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 interfaceToCopyableBuilder<KeywordMatchConfiguration.Builder,
KeywordMatchConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-