Package software.amazon.awssdk.services.rekognition.model

Class DetectLabelsImageForeground

java.lang.Object

software.amazon.awssdk.services.rekognition.model.DetectLabelsImageForeground

All Implemented Interfaces:

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

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

The foreground of the image with regard to image quality and dominant colors.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DetectLabelsImageForeground.Builder

Method Summary

Modifier and Type	Method	Description
static DetectLabelsImageForeground.Builder	builder()
List<DominantColor>	dominantColors()	The dominant colors found in the foreground of an image, defined with RGB values, CSS color name, simplified color name, and PixelPercentage (the percentage of image pixels that have a particular color).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDominantColors()	For responses, this returns true if the service returned a value for the DominantColors property.
int	hashCode()
DetectLabelsImageQuality	quality()	The quality of the image foreground as defined by brightness and sharpness.
List<SdkField<?>>	sdkFields()
static Class<? extends DetectLabelsImageForeground.Builder>	serializableBuilderClass()
DetectLabelsImageForeground.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

quality

public final DetectLabelsImageQuality quality()

The quality of the image foreground as defined by brightness and sharpness.

Returns:

The quality of the image foreground as defined by brightness and sharpness.

hasDominantColors

public final boolean hasDominantColors()

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

dominantColors

public final List<DominantColor> dominantColors()

The dominant colors found in the foreground of an image, defined with RGB values, CSS color name, simplified color name, and PixelPercentage (the percentage of image pixels that have a particular color).

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

Returns:

The dominant colors found in the foreground of an image, defined with RGB values, CSS color name, simplified color name, and PixelPercentage (the percentage of image pixels that have a particular color).

toBuilder

public DetectLabelsImageForeground.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DetectLabelsImageForeground.Builder,DetectLabelsImageForeground>

builder

public static DetectLabelsImageForeground.Builder builder()

serializableBuilderClass

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