software.amazon.awssdk.services.rekognition.model.ProtectiveEquipmentBodyPart Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.rekognition.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Information about a body part detected by DetectProtectiveEquipment that contains PPE. An array of
* ProtectiveEquipmentBodyPart objects is returned for each person detected by
* DetectProtectiveEquipment.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ProtectiveEquipmentBodyPart implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(ProtectiveEquipmentBodyPart::nameAsString)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField CONFIDENCE_FIELD = SdkField. builder(MarshallingType.FLOAT)
.memberName("Confidence").getter(getter(ProtectiveEquipmentBodyPart::confidence)).setter(setter(Builder::confidence))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Confidence").build()).build();
private static final SdkField> EQUIPMENT_DETECTIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("EquipmentDetections")
.getter(getter(ProtectiveEquipmentBodyPart::equipmentDetections))
.setter(setter(Builder::equipmentDetections))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EquipmentDetections").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(EquipmentDetection::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, CONFIDENCE_FIELD,
EQUIPMENT_DETECTIONS_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final Float confidence;
private final List equipmentDetections;
private ProtectiveEquipmentBodyPart(BuilderImpl builder) {
this.name = builder.name;
this.confidence = builder.confidence;
this.equipmentDetections = builder.equipmentDetections;
}
/**
*
* The detected body part.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #name} will return
* {@link BodyPart#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #nameAsString}.
*
*
* @return The detected body part.
* @see BodyPart
*/
public final BodyPart name() {
return BodyPart.fromValue(name);
}
/**
*
* The detected body part.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #name} will return
* {@link BodyPart#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #nameAsString}.
*
*
* @return The detected body part.
* @see BodyPart
*/
public final String nameAsString() {
return name;
}
/**
*
* The confidence that Amazon Rekognition has in the detection accuracy of the detected body part.
*
*
* @return The confidence that Amazon Rekognition has in the detection accuracy of the detected body part.
*/
public final Float confidence() {
return confidence;
}
/**
* For responses, this returns true if the service returned a value for the EquipmentDetections property. This DOES
* NOT check that the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasEquipmentDetections() {
return equipmentDetections != null && !(equipmentDetections instanceof SdkAutoConstructList);
}
/**
*
* An array of Personal Protective Equipment items detected around a body part.
*
*
* 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 {@link #hasEquipmentDetections} method.
*
*
* @return An array of Personal Protective Equipment items detected around a body part.
*/
public final List equipmentDetections() {
return equipmentDetections;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(nameAsString());
hashCode = 31 * hashCode + Objects.hashCode(confidence());
hashCode = 31 * hashCode + Objects.hashCode(hasEquipmentDetections() ? equipmentDetections() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ProtectiveEquipmentBodyPart)) {
return false;
}
ProtectiveEquipmentBodyPart other = (ProtectiveEquipmentBodyPart) obj;
return Objects.equals(nameAsString(), other.nameAsString()) && Objects.equals(confidence(), other.confidence())
&& hasEquipmentDetections() == other.hasEquipmentDetections()
&& Objects.equals(equipmentDetections(), other.equipmentDetections());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("ProtectiveEquipmentBodyPart").add("Name", nameAsString()).add("Confidence", confidence())
.add("EquipmentDetections", hasEquipmentDetections() ? equipmentDetections() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(nameAsString()));
case "Confidence":
return Optional.ofNullable(clazz.cast(confidence()));
case "EquipmentDetections":
return Optional.ofNullable(clazz.cast(equipmentDetections()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ProtectiveEquipmentBodyPart) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The detected body part.
*
*
* @param name
* The detected body part.
* @see BodyPart
* @return Returns a reference to this object so that method calls can be chained together.
* @see BodyPart
*/
Builder name(String name);
/**
*
* The detected body part.
*
*
* @param name
* The detected body part.
* @see BodyPart
* @return Returns a reference to this object so that method calls can be chained together.
* @see BodyPart
*/
Builder name(BodyPart name);
/**
*
* The confidence that Amazon Rekognition has in the detection accuracy of the detected body part.
*
*
* @param confidence
* The confidence that Amazon Rekognition has in the detection accuracy of the detected body part.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder confidence(Float confidence);
/**
*
* An array of Personal Protective Equipment items detected around a body part.
*
*
* @param equipmentDetections
* An array of Personal Protective Equipment items detected around a body part.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder equipmentDetections(Collection equipmentDetections);
/**
*
* An array of Personal Protective Equipment items detected around a body part.
*
*
* @param equipmentDetections
* An array of Personal Protective Equipment items detected around a body part.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder equipmentDetections(EquipmentDetection... equipmentDetections);
/**
*
* An array of Personal Protective Equipment items detected around a body part.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.rekognition.model.EquipmentDetection.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.rekognition.model.EquipmentDetection#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.rekognition.model.EquipmentDetection.Builder#build()} is called
* immediately and its result is passed to {@link #equipmentDetections(List)}.
*
* @param equipmentDetections
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.rekognition.model.EquipmentDetection.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #equipmentDetections(java.util.Collection)
*/
Builder equipmentDetections(Consumer... equipmentDetections);
}
static final class BuilderImpl implements Builder {
private String name;
private Float confidence;
private List equipmentDetections = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ProtectiveEquipmentBodyPart model) {
name(model.name);
confidence(model.confidence);
equipmentDetections(model.equipmentDetections);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
@Override
public final Builder name(BodyPart name) {
this.name(name == null ? null : name.toString());
return this;
}
public final Float getConfidence() {
return confidence;
}
public final void setConfidence(Float confidence) {
this.confidence = confidence;
}
@Override
public final Builder confidence(Float confidence) {
this.confidence = confidence;
return this;
}
public final List getEquipmentDetections() {
List result = EquipmentDetectionsCopier.copyToBuilder(this.equipmentDetections);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setEquipmentDetections(Collection equipmentDetections) {
this.equipmentDetections = EquipmentDetectionsCopier.copyFromBuilder(equipmentDetections);
}
@Override
public final Builder equipmentDetections(Collection equipmentDetections) {
this.equipmentDetections = EquipmentDetectionsCopier.copy(equipmentDetections);
return this;
}
@Override
@SafeVarargs
public final Builder equipmentDetections(EquipmentDetection... equipmentDetections) {
equipmentDetections(Arrays.asList(equipmentDetections));
return this;
}
@Override
@SafeVarargs
public final Builder equipmentDetections(Consumer... equipmentDetections) {
equipmentDetections(Stream.of(equipmentDetections).map(c -> EquipmentDetection.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public ProtectiveEquipmentBodyPart build() {
return new ProtectiveEquipmentBodyPart(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}