Package 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("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:

  • Method Details

    • 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()
      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 interface ToCopyableBuilder<ProtectiveEquipmentSummary.Builder,ProtectiveEquipmentSummary>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.