software.amazon.awssdk.services.kinesisvideo.model.StreamNameCondition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kinesisvideo Show documentation
The AWS Java SDK for Amazon Kinesis Video Streams module holds the client classes that are used for communicating with Amazon Kinesis Video Streams Service
There is a newer version: 2.30.1
Show newest version
/*
 * Copyright 2014-2019 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.kinesisvideo.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;

/**
 * 
 * Specifies the condition that streams must satisfy to be returned when you list streams (see the
 * ListStreams API). A condition has a comparison operation and a value. Currently, you can specify only
 * the BEGINS_WITH operator, which finds streams whose names start with a given prefix.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class StreamNameCondition implements SdkPojo, Serializable,
        ToCopyableBuilder {
    private static final SdkField COMPARISON_OPERATOR_FIELD = SdkField. builder(MarshallingType.STRING)
            .getter(getter(StreamNameCondition::comparisonOperatorAsString)).setter(setter(Builder::comparisonOperator))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ComparisonOperator").build())
            .build();

    private static final SdkField COMPARISON_VALUE_FIELD = SdkField. builder(MarshallingType.STRING)
            .getter(getter(StreamNameCondition::comparisonValue)).setter(setter(Builder::comparisonValue))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ComparisonValue").build()).build();

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

    private static final long serialVersionUID = 1L;

    private final String comparisonOperator;

    private final String comparisonValue;

    private StreamNameCondition(BuilderImpl builder) {
        this.comparisonOperator = builder.comparisonOperator;
        this.comparisonValue = builder.comparisonValue;
    }

    /**
     * 
     * A comparison operator. Currently, you can specify only the BEGINS_WITH operator, which finds streams
     * whose names start with a given prefix.
     * 
     * 
     * If the service returns an enum value that is not available in the current SDK version,
     * {@link #comparisonOperator} will return {@link ComparisonOperator#UNKNOWN_TO_SDK_VERSION}. The raw value returned
     * by the service is available from {@link #comparisonOperatorAsString}.
     * 
     * 
     * @return A comparison operator. Currently, you can specify only the BEGINS_WITH operator, which finds
     *         streams whose names start with a given prefix.
     * @see ComparisonOperator
     */
    public ComparisonOperator comparisonOperator() {
        return ComparisonOperator.fromValue(comparisonOperator);
    }

    /**
     * 
     * A comparison operator. Currently, you can specify only the BEGINS_WITH operator, which finds streams
     * whose names start with a given prefix.
     * 
     * 
     * If the service returns an enum value that is not available in the current SDK version,
     * {@link #comparisonOperator} will return {@link ComparisonOperator#UNKNOWN_TO_SDK_VERSION}. The raw value returned
     * by the service is available from {@link #comparisonOperatorAsString}.
     * 
     * 
     * @return A comparison operator. Currently, you can specify only the BEGINS_WITH operator, which finds
     *         streams whose names start with a given prefix.
     * @see ComparisonOperator
     */
    public String comparisonOperatorAsString() {
        return comparisonOperator;
    }

    /**
     * 
     * A value to compare.
     * 
     * 
     * @return A value to compare.
     */
    public String comparisonValue() {
        return comparisonValue;
    }

    @Override
    public Builder toBuilder() {
        return new BuilderImpl(this);
    }

    public static Builder builder() {
        return new BuilderImpl();
    }

    public static Class serializableBuilderClass() {
        return BuilderImpl.class;
    }

    @Override
    public int hashCode() {
        int hashCode = 1;
        hashCode = 31 * hashCode + Objects.hashCode(comparisonOperatorAsString());
        hashCode = 31 * hashCode + Objects.hashCode(comparisonValue());
        return hashCode;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (!(obj instanceof StreamNameCondition)) {
            return false;
        }
        StreamNameCondition other = (StreamNameCondition) obj;
        return Objects.equals(comparisonOperatorAsString(), other.comparisonOperatorAsString())
                && Objects.equals(comparisonValue(), other.comparisonValue());
    }

    /**
     * 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 String toString() {
        return ToString.builder("StreamNameCondition").add("ComparisonOperator", comparisonOperatorAsString())
                .add("ComparisonValue", comparisonValue()).build();
    }

    public  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "ComparisonOperator":
            return Optional.ofNullable(clazz.cast(comparisonOperatorAsString()));
        case "ComparisonValue":
            return Optional.ofNullable(clazz.cast(comparisonValue()));
        default:
            return Optional.empty();
        }
    }

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

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

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

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * A comparison operator. Currently, you can specify only the BEGINS_WITH operator, which finds
         * streams whose names start with a given prefix.
         * 
         * 
         * @param comparisonOperator
         *        A comparison operator. Currently, you can specify only the BEGINS_WITH operator, which
         *        finds streams whose names start with a given prefix.
         * @see ComparisonOperator
         * @return Returns a reference to this object so that method calls can be chained together.
         * @see ComparisonOperator
         */
        Builder comparisonOperator(String comparisonOperator);

        /**
         * 
         * A comparison operator. Currently, you can specify only the BEGINS_WITH operator, which finds
         * streams whose names start with a given prefix.
         * 
         * 
         * @param comparisonOperator
         *        A comparison operator. Currently, you can specify only the BEGINS_WITH operator, which
         *        finds streams whose names start with a given prefix.
         * @see ComparisonOperator
         * @return Returns a reference to this object so that method calls can be chained together.
         * @see ComparisonOperator
         */
        Builder comparisonOperator(ComparisonOperator comparisonOperator);

        /**
         * 
         * A value to compare.
         * 
         * 
         * @param comparisonValue
         *        A value to compare.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder comparisonValue(String comparisonValue);
    }

    static final class BuilderImpl implements Builder {
        private String comparisonOperator;

        private String comparisonValue;

        private BuilderImpl() {
        }

        private BuilderImpl(StreamNameCondition model) {
            comparisonOperator(model.comparisonOperator);
            comparisonValue(model.comparisonValue);
        }

        public final String getComparisonOperatorAsString() {
            return comparisonOperator;
        }

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

        @Override
        public final Builder comparisonOperator(ComparisonOperator comparisonOperator) {
            this.comparisonOperator(comparisonOperator.toString());
            return this;
        }

        public final void setComparisonOperator(String comparisonOperator) {
            this.comparisonOperator = comparisonOperator;
        }

        public final String getComparisonValue() {
            return comparisonValue;
        }

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

        public final void setComparisonValue(String comparisonValue) {
            this.comparisonValue = comparisonValue;
        }

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

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