software.amazon.awssdk.services.rekognition.model

Class ProtectiveEquipmentSummary

java.lang.Object

software.amazon.awssdk.services.rekognition.model.ProtectiveEquipmentSummary

All Implemented Interfaces:

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

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

Summary information for required items of personal protective equipment (PPE) detected on persons by a call to DetectProtectiveEquipment. You specify the required type of PPE in the SummarizationAttributes (ProtectiveEquipmentSummarizationAttributes) input parameter. The summary includes which persons were detected wearing the required personal protective equipment (PersonsWithRequiredEquipment), which persons were detected as not wearing the required PPE (PersonsWithoutRequiredEquipment), and the persons in which a determination could not be made (PersonsIndeterminate).

To get a total for each category, use the size of the field array. For example, to find out how many people were detected as wearing the specified PPE, use the size of the PersonsWithRequiredEquipment array. If you want to find out more about a person, such as the location (BoundingBox) of the person on the image, use the person ID in each array element. Each person ID matches the ID field of a ProtectiveEquipmentPerson object returned in the Persons array by DetectProtectiveEquipment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProtectiveEquipmentSummary.Builder

Method Summary

Modifier and Type	Method and Description
static ProtectiveEquipmentSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPersonsIndeterminate() For responses, this returns true if the service returned a value for the PersonsIndeterminate property.
boolean	hasPersonsWithoutRequiredEquipment() For responses, this returns true if the service returned a value for the PersonsWithoutRequiredEquipment property.
boolean	hasPersonsWithRequiredEquipment() For responses, this returns true if the service returned a value for the PersonsWithRequiredEquipment property.
List<Integer>	personsIndeterminate() An array of IDs for persons where it was not possible to determine if they are wearing personal protective equipment.
List<Integer>	personsWithoutRequiredEquipment() An array of IDs for persons who are not wearing all of the types of PPE specified in the RequiredEquipmentTypes field of the detected personal protective equipment.
List<Integer>	personsWithRequiredEquipment() An array of IDs for persons who are wearing detected personal protective equipment.
List<SdkField<?>>	sdkFields()
static Class<? extends ProtectiveEquipmentSummary.Builder>	serializableBuilderClass()
ProtectiveEquipmentSummary.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

hasPersonsWithRequiredEquipment

public final boolean hasPersonsWithRequiredEquipment()

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

personsWithRequiredEquipment

public final List<Integer> personsWithRequiredEquipment()

An array of IDs for persons who are wearing detected personal protective equipment.

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

Returns:

An array of IDs for persons who are wearing detected personal protective equipment.

hasPersonsWithoutRequiredEquipment

public final boolean hasPersonsWithoutRequiredEquipment()

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

personsWithoutRequiredEquipment

public final List<Integer> personsWithoutRequiredEquipment()

An array of IDs for persons who are not wearing all of the types of PPE specified in the RequiredEquipmentTypes field of the detected personal protective equipment.

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

Returns:

An array of IDs for persons who are not wearing all of the types of PPE specified in the RequiredEquipmentTypes field of the detected personal protective equipment.

hasPersonsIndeterminate

public final boolean hasPersonsIndeterminate()

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

personsIndeterminate

public final List<Integer> personsIndeterminate()

An array of IDs for persons where it was not possible to determine if they are wearing personal protective equipment.

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

Returns:

An array of IDs for persons where it was not possible to determine if they are wearing personal protective equipment.

toBuilder

public ProtectiveEquipmentSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ProtectiveEquipmentSummary.Builder,ProtectiveEquipmentSummary>

builder

public static ProtectiveEquipmentSummary.Builder builder()

serializableBuilderClass

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