Class ProtectiveEquipmentSummarizationAttributes
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
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 RequiredEquipmentTypes property.final Float
The minimum confidence level for which you want summary information.final List
<ProtectiveEquipmentType> An array of personal protective equipment types for which you want summary information.An array of personal protective equipment types for which you want summary information.static Class
<? extends ProtectiveEquipmentSummarizationAttributes.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
-
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% asDetectProtectiveEquipment
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% asDetectProtectiveEquipment
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
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 byDetectProtectiveEquipment
.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 byDetectProtectiveEquipment
.
-
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 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. -
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 byDetectProtectiveEquipment
.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 byDetectProtectiveEquipment
.
-
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<ProtectiveEquipmentSummarizationAttributes.Builder,
ProtectiveEquipmentSummarizationAttributes> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends ProtectiveEquipmentSummarizationAttributes.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
-