software.amazon.awssdk.services.elasticache.model.AuthenticationMode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticache Show documentation
The AWS Java SDK for Amazon ElastiCache module holds the client classes that are used for communicating with Amazon ElastiCache Service
The newest version!
/*
 * 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.elasticache.model;

import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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.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;

/**
 * 
 * Specifies the authentication mode to use.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class AuthenticationMode implements SdkPojo, Serializable,
        ToCopyableBuilder {
    private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Type")
            .getter(getter(AuthenticationMode::typeAsString)).setter(setter(Builder::type))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Type").build()).build();

    private static final SdkField> PASSWORDS_FIELD = SdkField
            .> builder(MarshallingType.LIST)
            .memberName("Passwords")
            .getter(getter(AuthenticationMode::passwords))
            .setter(setter(Builder::passwords))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Passwords").build(),
                    ListTrait
                            .builder()
                            .memberLocationName(null)
                            .memberFieldInfo(
                                    SdkField. builder(MarshallingType.STRING)
                                            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
                                                    .locationName("member").build()).build()).build()).build();

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

    private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();

    private static final long serialVersionUID = 1L;

    private final String type;

    private final List passwords;

    private AuthenticationMode(BuilderImpl builder) {
        this.type = builder.type;
        this.passwords = builder.passwords;
    }

    /**
     * 
     * Specifies the authentication type. Possible options are IAM authentication, password and no password.
     * 
     * 
     * If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
     * {@link InputAuthenticationType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
     * {@link #typeAsString}.
     * 
     * 
     * @return Specifies the authentication type. Possible options are IAM authentication, password and no password.
     * @see InputAuthenticationType
     */
    public final InputAuthenticationType type() {
        return InputAuthenticationType.fromValue(type);
    }

    /**
     * 
     * Specifies the authentication type. Possible options are IAM authentication, password and no password.
     * 
     * 
     * If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
     * {@link InputAuthenticationType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
     * {@link #typeAsString}.
     * 
     * 
     * @return Specifies the authentication type. Possible options are IAM authentication, password and no password.
     * @see InputAuthenticationType
     */
    public final String typeAsString() {
        return type;
    }

    /**
     * For responses, this returns true if the service returned a value for the Passwords 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 hasPasswords() {
        return passwords != null && !(passwords instanceof SdkAutoConstructList);
    }

    /**
     * 
     * Specifies the passwords to use for authentication if Type is set to password.
     * 
     * 
     * 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 #hasPasswords} method.
     * 
     * 
     * @return Specifies the passwords to use for authentication if Type is set to password.
     */
    public final List passwords() {
        return passwords;
    }

    @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(hasPasswords() ? passwords() : 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 AuthenticationMode)) {
            return false;
        }
        AuthenticationMode other = (AuthenticationMode) obj;
        return Objects.equals(typeAsString(), other.typeAsString()) && hasPasswords() == other.hasPasswords()
                && Objects.equals(passwords(), other.passwords());
    }

    /**
     * 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("AuthenticationMode").add("Type", typeAsString())
                .add("Passwords", hasPasswords() ? passwords() : null).build();
    }

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

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

    @Override
    public final Map> sdkFieldNameToField() {
        return SDK_NAME_TO_FIELD;
    }

    private static Map> memberNameToFieldInitializer() {
        Map> map = new HashMap<>();
        map.put("Type", TYPE_FIELD);
        map.put("Passwords", PASSWORDS_FIELD);
        return Collections.unmodifiableMap(map);
    }

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

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

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * Specifies the authentication type. Possible options are IAM authentication, password and no password.
         * 
         * 
         * @param type
         *        Specifies the authentication type. Possible options are IAM authentication, password and no password.
         * @see InputAuthenticationType
         * @return Returns a reference to this object so that method calls can be chained together.
         * @see InputAuthenticationType
         */
        Builder type(String type);

        /**
         * 
         * Specifies the authentication type. Possible options are IAM authentication, password and no password.
         * 
         * 
         * @param type
         *        Specifies the authentication type. Possible options are IAM authentication, password and no password.
         * @see InputAuthenticationType
         * @return Returns a reference to this object so that method calls can be chained together.
         * @see InputAuthenticationType
         */
        Builder type(InputAuthenticationType type);

        /**
         * 
         * Specifies the passwords to use for authentication if Type is set to password.
         * 
         * 
         * @param passwords
         *        Specifies the passwords to use for authentication if Type is set to password
         *        .
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder passwords(Collection passwords);

        /**
         * 
         * Specifies the passwords to use for authentication if Type is set to password.
         * 
         * 
         * @param passwords
         *        Specifies the passwords to use for authentication if Type is set to password
         *        .
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder passwords(String... passwords);
    }

    static final class BuilderImpl implements Builder {
        private String type;

        private List passwords = DefaultSdkAutoConstructList.getInstance();

        private BuilderImpl() {
        }

        private BuilderImpl(AuthenticationMode model) {
            type(model.type);
            passwords(model.passwords);
        }

        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(InputAuthenticationType type) {
            this.type(type == null ? null : type.toString());
            return this;
        }

        public final Collection getPasswords() {
            if (passwords instanceof SdkAutoConstructList) {
                return null;
            }
            return passwords;
        }

        public final void setPasswords(Collection passwords) {
            this.passwords = PasswordListInputCopier.copy(passwords);
        }

        @Override
        public final Builder passwords(Collection passwords) {
            this.passwords = PasswordListInputCopier.copy(passwords);
            return this;
        }

        @Override
        @SafeVarargs
        public final Builder passwords(String... passwords) {
            passwords(Arrays.asList(passwords));
            return this;
        }

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

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

        @Override
        public Map> sdkFieldNameToField() {
            return SDK_NAME_TO_FIELD;
        }
    }
}