software.amazon.awssdk.services.chimesdkmediapipelines.model

Class SentimentConfiguration

java.lang.Object

software.amazon.awssdk.services.chimesdkmediapipelines.model.SentimentConfiguration

All Implemented Interfaces:

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

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

A structure that contains the configuration settings for a sentiment analysis task.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SentimentConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static SentimentConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	ruleName() The name of the rule in the sentiment configuration.
List<SdkField<?>>	sdkFields()
SentimentType	sentimentType() The type of sentiment, POSITIVE, NEGATIVE, or NEUTRAL.
String	sentimentTypeAsString() The type of sentiment, POSITIVE, NEGATIVE, or NEUTRAL.
static Class<? extends SentimentConfiguration.Builder>	serializableBuilderClass()
Integer	timePeriod() Specifies the analysis interval.
SentimentConfiguration.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 rule in the sentiment configuration.

Returns:

The name of the rule in the sentiment configuration.

sentimentType

public final SentimentType sentimentType()

The type of sentiment, POSITIVE, NEGATIVE, or NEUTRAL.

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

Returns:

The type of sentiment, POSITIVE, NEGATIVE, or NEUTRAL.

See Also:

SentimentType

sentimentTypeAsString

public final String sentimentTypeAsString()

The type of sentiment, POSITIVE, NEGATIVE, or NEUTRAL.

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

Returns:

The type of sentiment, POSITIVE, NEGATIVE, or NEUTRAL.

See Also:

SentimentType

timePeriod

public final Integer timePeriod()

Specifies the analysis interval.

Returns:

Specifies the analysis interval.

toBuilder

public SentimentConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SentimentConfiguration.Builder,SentimentConfiguration>

builder

public static SentimentConfiguration.Builder builder()

serializableBuilderClass

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