software.amazon.awssdk.services.rekognition.model.FaceSearchSettings 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.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Input face recognition parameters for an Amazon Rekognition stream processor. Includes the collection to use for face
* recognition and the face attributes to detect. Defining the settings is required in the request parameter for
* CreateStreamProcessor.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class FaceSearchSettings implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField COLLECTION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("CollectionId").getter(getter(FaceSearchSettings::collectionId)).setter(setter(Builder::collectionId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CollectionId").build()).build();
private static final SdkField FACE_MATCH_THRESHOLD_FIELD = SdkField. builder(MarshallingType.FLOAT)
.memberName("FaceMatchThreshold").getter(getter(FaceSearchSettings::faceMatchThreshold))
.setter(setter(Builder::faceMatchThreshold))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FaceMatchThreshold").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(COLLECTION_ID_FIELD,
FACE_MATCH_THRESHOLD_FIELD));
private static final long serialVersionUID = 1L;
private final String collectionId;
private final Float faceMatchThreshold;
private FaceSearchSettings(BuilderImpl builder) {
this.collectionId = builder.collectionId;
this.faceMatchThreshold = builder.faceMatchThreshold;
}
/**
*
* The ID of a collection that contains faces that you want to search for.
*
*
* @return The ID of a collection that contains faces that you want to search for.
*/
public final String collectionId() {
return collectionId;
}
/**
*
* Minimum face match confidence score that must be met to return a result for a recognized face. The default is 80.
* 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted, and values
* lower than 80 are set to 80.
*
*
* @return Minimum face match confidence score that must be met to return a result for a recognized face. The
* default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are
* accepted, and values lower than 80 are set to 80.
*/
public final Float faceMatchThreshold() {
return faceMatchThreshold;
}
@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(collectionId());
hashCode = 31 * hashCode + Objects.hashCode(faceMatchThreshold());
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 FaceSearchSettings)) {
return false;
}
FaceSearchSettings other = (FaceSearchSettings) obj;
return Objects.equals(collectionId(), other.collectionId())
&& Objects.equals(faceMatchThreshold(), other.faceMatchThreshold());
}
/**
* 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("FaceSearchSettings").add("CollectionId", collectionId())
.add("FaceMatchThreshold", faceMatchThreshold()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CollectionId":
return Optional.ofNullable(clazz.cast(collectionId()));
case "FaceMatchThreshold":
return Optional.ofNullable(clazz.cast(faceMatchThreshold()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((FaceSearchSettings) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The ID of a collection that contains faces that you want to search for.
*
*
* @param collectionId
* The ID of a collection that contains faces that you want to search for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder collectionId(String collectionId);
/**
*
* Minimum face match confidence score that must be met to return a result for a recognized face. The default is
* 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted, and
* values lower than 80 are set to 80.
*
*
* @param faceMatchThreshold
* Minimum face match confidence score that must be met to return a result for a recognized face. The
* default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are
* accepted, and values lower than 80 are set to 80.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder faceMatchThreshold(Float faceMatchThreshold);
}
static final class BuilderImpl implements Builder {
private String collectionId;
private Float faceMatchThreshold;
private BuilderImpl() {
}
private BuilderImpl(FaceSearchSettings model) {
collectionId(model.collectionId);
faceMatchThreshold(model.faceMatchThreshold);
}
public final String getCollectionId() {
return collectionId;
}
public final void setCollectionId(String collectionId) {
this.collectionId = collectionId;
}
@Override
public final Builder collectionId(String collectionId) {
this.collectionId = collectionId;
return this;
}
public final Float getFaceMatchThreshold() {
return faceMatchThreshold;
}
public final void setFaceMatchThreshold(Float faceMatchThreshold) {
this.faceMatchThreshold = faceMatchThreshold;
}
@Override
public final Builder faceMatchThreshold(Float faceMatchThreshold) {
this.faceMatchThreshold = faceMatchThreshold;
return this;
}
@Override
public FaceSearchSettings build() {
return new FaceSearchSettings(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy