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

Class ProtectiveEquipmentSummarizationAttributes

java.lang.Object

software.amazon.awssdk.services.rekognition.model.ProtectiveEquipmentSummarizationAttributes

All Implemented Interfaces:

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

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

Specifies summary attributes to return from a call to DetectProtectiveEquipment. You can specify which types of PPE to summarize. You can also specify a minimum confidence value for detections. Summary information is returned in the Summary (ProtectiveEquipmentSummary) field of the response from DetectProtectiveEquipment. The summary includes which persons in an image were detected wearing the requested types of person protective equipment (PPE), which persons were detected as not wearing PPE, and the persons in which a determination could not be made. For more information, see ProtectiveEquipmentSummary.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProtectiveEquipmentSummarizationAttributes.Builder

Method Summary

Modifier and Type	Method	Description
static ProtectiveEquipmentSummarizationAttributes.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRequiredEquipmentTypes()	For responses, this returns true if the service returned a value for the RequiredEquipmentTypes property.
Float	minConfidence()	The minimum confidence level for which you want summary information.
List<ProtectiveEquipmentType>	requiredEquipmentTypes()	An array of personal protective equipment types for which you want summary information.
List<String>	requiredEquipmentTypesAsStrings()	An array of personal protective equipment types for which you want summary information.
List<SdkField<?>>	sdkFields()
static Class<? extends ProtectiveEquipmentSummarizationAttributes.Builder>	serializableBuilderClass()
ProtectiveEquipmentSummarizationAttributes.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

minConfidence

public final Float minConfidence()

The minimum confidence level for which you want summary information. The confidence level applies to person detection, body part detection, equipment detection, and body part coverage. Amazon Rekognition doesn't return summary information with a confidence than this specified value. There isn't a default value.

Specify a MinConfidence value that is between 50-100% as DetectProtectiveEquipment returns predictions only where the detection confidence is between 50% - 100%. If you specify a value that is less than 50%, the results are the same specifying a value of 50%.

Returns:

The minimum confidence level for which you want summary information. The confidence level applies to person detection, body part detection, equipment detection, and body part coverage. Amazon Rekognition doesn't return summary information with a confidence than this specified value. There isn't a default value.

Specify a MinConfidence value that is between 50-100% as DetectProtectiveEquipment returns predictions only where the detection confidence is between 50% - 100%. If you specify a value that is less than 50%, the results are the same specifying a value of 50%.

requiredEquipmentTypes

public final List<ProtectiveEquipmentType> requiredEquipmentTypes()

An array of personal protective equipment types for which you want summary information. If a person is detected wearing a required requipment type, the person's ID is added to the PersonsWithRequiredEquipment array field returned in ProtectiveEquipmentSummary by DetectProtectiveEquipment.

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

Returns:

An array of personal protective equipment types for which you want summary information. If a person is detected wearing a required requipment type, the person's ID is added to the PersonsWithRequiredEquipment array field returned in ProtectiveEquipmentSummary by DetectProtectiveEquipment.

hasRequiredEquipmentTypes

public final boolean hasRequiredEquipmentTypes()

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

requiredEquipmentTypesAsStrings

public final List<String> requiredEquipmentTypesAsStrings()

An array of personal protective equipment types for which you want summary information. If a person is detected wearing a required requipment type, the person's ID is added to the PersonsWithRequiredEquipment array field returned in ProtectiveEquipmentSummary by DetectProtectiveEquipment.

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

Returns:

An array of personal protective equipment types for which you want summary information. If a person is detected wearing a required requipment type, the person's ID is added to the PersonsWithRequiredEquipment array field returned in ProtectiveEquipmentSummary by DetectProtectiveEquipment.

toBuilder

public ProtectiveEquipmentSummarizationAttributes.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ProtectiveEquipmentSummarizationAttributes.Builder,ProtectiveEquipmentSummarizationAttributes>

builder

public static ProtectiveEquipmentSummarizationAttributes.Builder builder()

serializableBuilderClass

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