software.amazon.awssdk.services.rekognition.model.TechnicalCueSegment Maven / Gradle / Ivy

Go to download
/*
 * 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;

/**
 * 
 * Information about a technical cue segment. For more information, see SegmentDetection.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class TechnicalCueSegment implements SdkPojo, Serializable,
        ToCopyableBuilder {
    private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Type")
            .getter(getter(TechnicalCueSegment::typeAsString)).setter(setter(Builder::type))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Type").build()).build();

    private static final SdkField CONFIDENCE_FIELD = SdkField. builder(MarshallingType.FLOAT)
            .memberName("Confidence").getter(getter(TechnicalCueSegment::confidence)).setter(setter(Builder::confidence))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Confidence").build()).build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TYPE_FIELD, CONFIDENCE_FIELD));

    private static final long serialVersionUID = 1L;

    private final String type;

    private final Float confidence;

    private TechnicalCueSegment(BuilderImpl builder) {
        this.type = builder.type;
        this.confidence = builder.confidence;
    }

    /**
     * 
     * The type of the technical cue.
     * 
     * 
     * If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
     * {@link TechnicalCueType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
     * {@link #typeAsString}.
     * 
     * 
     * @return The type of the technical cue.
     * @see TechnicalCueType
     */
    public final TechnicalCueType type() {
        return TechnicalCueType.fromValue(type);
    }

    /**
     * 
     * The type of the technical cue.
     * 
     * 
     * If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
     * {@link TechnicalCueType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
     * {@link #typeAsString}.
     * 
     * 
     * @return The type of the technical cue.
     * @see TechnicalCueType
     */
    public final String typeAsString() {
        return type;
    }

    /**
     * 
     * The confidence that Amazon Rekognition Video has in the accuracy of the detected segment.
     * 
     * 
     * @return The confidence that Amazon Rekognition Video has in the accuracy of the detected segment.
     */
    public final Float confidence() {
        return confidence;
    }

    @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(typeAsString());
        hashCode = 31 * hashCode + Objects.hashCode(confidence());
        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 TechnicalCueSegment)) {
            return false;
        }
        TechnicalCueSegment other = (TechnicalCueSegment) obj;
        return Objects.equals(typeAsString(), other.typeAsString()) && Objects.equals(confidence(), other.confidence());
    }

    /**
     * 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("TechnicalCueSegment").add("Type", typeAsString()).add("Confidence", confidence()).build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "Type":
            return Optional.ofNullable(clazz.cast(typeAsString()));
        case "Confidence":
            return Optional.ofNullable(clazz.cast(confidence()));
        default:
            return Optional.empty();
        }
    }

    @Override
    public final List> sdkFields() {
        return SDK_FIELDS;
    }

    private static  Function getter(Function g) {
        return obj -> g.apply((TechnicalCueSegment) obj);
    }

    private static  BiConsumer setter(BiConsumer s) {
        return (obj, val) -> s.accept((Builder) obj, val);
    }

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * The type of the technical cue.
         * 
         * 
         * @param type
         *        The type of the technical cue.
         * @see TechnicalCueType
         * @return Returns a reference to this object so that method calls can be chained together.
         * @see TechnicalCueType
         */
        Builder type(String type);

        /**
         * 
         * The type of the technical cue.
         * 
         * 
         * @param type
         *        The type of the technical cue.
         * @see TechnicalCueType
         * @return Returns a reference to this object so that method calls can be chained together.
         * @see TechnicalCueType
         */
        Builder type(TechnicalCueType type);

        /**
         * 
         * The confidence that Amazon Rekognition Video has in the accuracy of the detected segment.
         * 
         * 
         * @param confidence
         *        The confidence that Amazon Rekognition Video has in the accuracy of the detected segment.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder confidence(Float confidence);
    }

    static final class BuilderImpl implements Builder {
        private String type;

        private Float confidence;

        private BuilderImpl() {
        }

        private BuilderImpl(TechnicalCueSegment model) {
            type(model.type);
            confidence(model.confidence);
        }

        public final String getType() {
            return type;
        }

        public final void setType(String type) {
            this.type = type;
        }

        @Override
        public final Builder type(String type) {
            this.type = type;
            return this;
        }

        @Override
        public final Builder type(TechnicalCueType type) {
            this.type(type == null ? null : type.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;
        }

        @Override
        public TechnicalCueSegment build() {
            return new TechnicalCueSegment(this);
        }

        @Override
        public List> sdkFields() {
            return SDK_FIELDS;
        }
    }
}