java.lang.Object
- software.amazon.awssdk.services.rekognition.model.DetectLabelsImageProperties

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DetectLabelsImageProperties.Builder,DetectLabelsImageProperties>
```
@Generated("software.amazon.awssdk:codegen")
public final class DetectLabelsImageProperties
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DetectLabelsImageProperties.Builder,DetectLabelsImageProperties>
```
Information about the quality and dominant colors of an input image. Quality and color information is returned for the entire image, foreground, and background.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DetectLabelsImageProperties.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DetectLabelsImageBackground`	`background()`	Information about the properties of an image’s background, including the background’s quality and dominant colors, including the quality and dominant colors of the image.
`static DetectLabelsImageProperties.Builder`	`builder()`
`List<DominantColor>`	`dominantColors()`	Information about the dominant colors found in an image, described 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)`
`DetectLabelsImageForeground`	`foreground()`	Information about the properties of an image’s foreground, including the foreground’s quality and dominant colors, including the quality and dominant colors of the image.
`<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()`	Information about the quality of the image foreground as defined by brightness, sharpness, and contrast.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DetectLabelsImageProperties.Builder>`	`serializableBuilderClass()`
`DetectLabelsImageProperties.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()
```
    Information about the quality of the image foreground as defined by brightness, sharpness, and contrast. The higher the value the greater the brightness, sharpness, and contrast respectively.
    
    Returns:
    
    Information about the quality of the image foreground as defined by brightness, sharpness, and contrast. The higher the value the greater the brightness, sharpness, and contrast respectively.
  - 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()
```
    Information about the dominant colors found in an image, described 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:
    
    Information about the dominant colors found in an image, described with RGB values, CSS color name, simplified color name, and PixelPercentage (the percentage of image pixels that have a particular color).
  - foreground
```
public final DetectLabelsImageForeground foreground()
```
    Information about the properties of an image’s foreground, including the foreground’s quality and dominant colors, including the quality and dominant colors of the image.
    
    Returns:
    
    Information about the properties of an image’s foreground, including the foreground’s quality and dominant colors, including the quality and dominant colors of the image.
  - background
```
public final DetectLabelsImageBackground background()
```
    Information about the properties of an image’s background, including the background’s quality and dominant colors, including the quality and dominant colors of the image.
    
    Returns:
    
    Information about the properties of an image’s background, including the background’s quality and dominant colors, including the quality and dominant colors of the image.
  - toBuilder
```
public DetectLabelsImageProperties.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DetectLabelsImageProperties.Builder,DetectLabelsImageProperties>
  - builder
```
public static DetectLabelsImageProperties.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DetectLabelsImageProperties.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class DetectLabelsImageProperties

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

quality

hasDominantColors

dominantColors

foreground

background

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField