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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GeneralLabelsSettings.Builder,GeneralLabelsSettings>
```
@Generated("software.amazon.awssdk:codegen")
public final class GeneralLabelsSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GeneralLabelsSettings.Builder,GeneralLabelsSettings>
```
Contains filters for the object labels returned by DetectLabels. Filters can be inclusive, exclusive, or a combination of both and can be applied to individual labels or entire label categories. To see a list of label categories, see Detecting Labels.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GeneralLabelsSettings.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GeneralLabelsSettings.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasLabelCategoryExclusionFilters()`	For responses, this returns true if the service returned a value for the LabelCategoryExclusionFilters property.
`boolean`	`hasLabelCategoryInclusionFilters()`	For responses, this returns true if the service returned a value for the LabelCategoryInclusionFilters property.
`boolean`	`hasLabelExclusionFilters()`	For responses, this returns true if the service returned a value for the LabelExclusionFilters property.
`boolean`	`hasLabelInclusionFilters()`	For responses, this returns true if the service returned a value for the LabelInclusionFilters property.
`List<String>`	`labelCategoryExclusionFilters()`	The label categories that should be excluded from the return from DetectLabels.
`List<String>`	`labelCategoryInclusionFilters()`	The label categories that should be included in the return from DetectLabels.
`List<String>`	`labelExclusionFilters()`	The labels that should be excluded from the return from DetectLabels.
`List<String>`	`labelInclusionFilters()`	The labels that should be included in the return from DetectLabels.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GeneralLabelsSettings.Builder>`	`serializableBuilderClass()`
`GeneralLabelsSettings.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
  - hasLabelInclusionFilters
```
public final boolean hasLabelInclusionFilters()
```
    For responses, this returns true if the service returned a value for the LabelInclusionFilters 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.
  - labelInclusionFilters
```
public final List<String> labelInclusionFilters()
```
    The labels that should be included in the return from DetectLabels.
    
    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 hasLabelInclusionFilters() method.
    
    Returns:
    
    The labels that should be included in the return from DetectLabels.
  - hasLabelExclusionFilters
```
public final boolean hasLabelExclusionFilters()
```
    For responses, this returns true if the service returned a value for the LabelExclusionFilters 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.
  - labelExclusionFilters
```
public final List<String> labelExclusionFilters()
```
    The labels that should be excluded from the return from DetectLabels.
    
    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 hasLabelExclusionFilters() method.
    
    Returns:
    
    The labels that should be excluded from the return from DetectLabels.
  - hasLabelCategoryInclusionFilters
```
public final boolean hasLabelCategoryInclusionFilters()
```
    For responses, this returns true if the service returned a value for the LabelCategoryInclusionFilters 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.
  - labelCategoryInclusionFilters
```
public final List<String> labelCategoryInclusionFilters()
```
    The label categories that should be included in the return from DetectLabels.
    
    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 hasLabelCategoryInclusionFilters() method.
    
    Returns:
    
    The label categories that should be included in the return from DetectLabels.
  - hasLabelCategoryExclusionFilters
```
public final boolean hasLabelCategoryExclusionFilters()
```
    For responses, this returns true if the service returned a value for the LabelCategoryExclusionFilters 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.
  - labelCategoryExclusionFilters
```
public final List<String> labelCategoryExclusionFilters()
```
    The label categories that should be excluded from the return from DetectLabels.
    
    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 hasLabelCategoryExclusionFilters() method.
    
    Returns:
    
    The label categories that should be excluded from the return from DetectLabels.
  - toBuilder
```
public GeneralLabelsSettings.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GeneralLabelsSettings.Builder,GeneralLabelsSettings>
  - builder
```
public static GeneralLabelsSettings.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GeneralLabelsSettings.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

Class GeneralLabelsSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasLabelInclusionFilters

labelInclusionFilters

hasLabelExclusionFilters

labelExclusionFilters

hasLabelCategoryInclusionFilters

labelCategoryInclusionFilters

hasLabelCategoryExclusionFilters

labelCategoryExclusionFilters

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields