Class GeneralLabelsSettings
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
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 LabelCategoryExclusionFilters property.final boolean
For responses, this returns true if the service returned a value for the LabelCategoryInclusionFilters property.final boolean
For responses, this returns true if the service returned a value for the LabelExclusionFilters property.final boolean
For responses, this returns true if the service returned a value for the LabelInclusionFilters property.The label categories that should be excluded from the return from DetectLabels.The label categories that should be included in the return from DetectLabels.The labels that should be excluded from the return from DetectLabels.The labels that should be included in the return from DetectLabels.static Class
<? extends GeneralLabelsSettings.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
-
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 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. -
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 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. -
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 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. -
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 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. -
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
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<GeneralLabelsSettings.Builder,
GeneralLabelsSettings> - 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
-