software.amazon.awssdk.services.ssm.model.PutParameterResponse 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.ssm.model;

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;

/**
 */
@Generated("software.amazon.awssdk:codegen")
public final class PutParameterResponse extends SsmResponse implements
        ToCopyableBuilder {
    private static final SdkField VERSION_FIELD = SdkField. builder(MarshallingType.LONG).memberName("Version")
            .getter(getter(PutParameterResponse::version)).setter(setter(Builder::version))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Version").build()).build();

    private static final SdkField TIER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Tier")
            .getter(getter(PutParameterResponse::tierAsString)).setter(setter(Builder::tier))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tier").build()).build();

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

    private final Long version;

    private final String tier;

    private PutParameterResponse(BuilderImpl builder) {
        super(builder);
        this.version = builder.version;
        this.tier = builder.tier;
    }

    /**
     * 
     * The new version number of a parameter. If you edit a parameter value, Parameter Store automatically creates a new
     * version and assigns this new version a unique ID. You can reference a parameter version ID in API actions or in
     * Systems Manager documents (SSM documents). By default, if you don't specify a specific version, the system
     * returns the latest parameter value when a parameter is called.
     * 
     * 
     * @return The new version number of a parameter. If you edit a parameter value, Parameter Store automatically
     *         creates a new version and assigns this new version a unique ID. You can reference a parameter version ID
     *         in API actions or in Systems Manager documents (SSM documents). By default, if you don't specify a
     *         specific version, the system returns the latest parameter value when a parameter is called.
     */
    public Long version() {
        return version;
    }

    /**
     * 
     * The tier assigned to the parameter.
     * 
     * 
     * If the service returns an enum value that is not available in the current SDK version, {@link #tier} will return
     * {@link ParameterTier#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
     * {@link #tierAsString}.
     * 
     * 
     * @return The tier assigned to the parameter.
     * @see ParameterTier
     */
    public ParameterTier tier() {
        return ParameterTier.fromValue(tier);
    }

    /**
     * 
     * The tier assigned to the parameter.
     * 
     * 
     * If the service returns an enum value that is not available in the current SDK version, {@link #tier} will return
     * {@link ParameterTier#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
     * {@link #tierAsString}.
     * 
     * 
     * @return The tier assigned to the parameter.
     * @see ParameterTier
     */
    public String tierAsString() {
        return tier;
    }

    @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 + super.hashCode();
        hashCode = 31 * hashCode + Objects.hashCode(version());
        hashCode = 31 * hashCode + Objects.hashCode(tierAsString());
        return hashCode;
    }

    @Override
    public boolean equals(Object obj) {
        return super.equals(obj) && equalsBySdkFields(obj);
    }

    @Override
    public boolean equalsBySdkFields(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (!(obj instanceof PutParameterResponse)) {
            return false;
        }
        PutParameterResponse other = (PutParameterResponse) obj;
        return Objects.equals(version(), other.version()) && Objects.equals(tierAsString(), other.tierAsString());
    }

    /**
     * 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("PutParameterResponse").add("Version", version()).add("Tier", tierAsString()).build();
    }

    public  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "Version":
            return Optional.ofNullable(clazz.cast(version()));
        case "Tier":
            return Optional.ofNullable(clazz.cast(tierAsString()));
        default:
            return Optional.empty();
        }
    }

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

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

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

    public interface Builder extends SsmResponse.Builder, SdkPojo, CopyableBuilder {
        /**
         * 
         * The new version number of a parameter. If you edit a parameter value, Parameter Store automatically creates a
         * new version and assigns this new version a unique ID. You can reference a parameter version ID in API actions
         * or in Systems Manager documents (SSM documents). By default, if you don't specify a specific version, the
         * system returns the latest parameter value when a parameter is called.
         * 
         * 
         * @param version
         *        The new version number of a parameter. If you edit a parameter value, Parameter Store automatically
         *        creates a new version and assigns this new version a unique ID. You can reference a parameter version
         *        ID in API actions or in Systems Manager documents (SSM documents). By default, if you don't specify a
         *        specific version, the system returns the latest parameter value when a parameter is called.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder version(Long version);

        /**
         * 
         * The tier assigned to the parameter.
         * 
         * 
         * @param tier
         *        The tier assigned to the parameter.
         * @see ParameterTier
         * @return Returns a reference to this object so that method calls can be chained together.
         * @see ParameterTier
         */
        Builder tier(String tier);

        /**
         * 
         * The tier assigned to the parameter.
         * 
         * 
         * @param tier
         *        The tier assigned to the parameter.
         * @see ParameterTier
         * @return Returns a reference to this object so that method calls can be chained together.
         * @see ParameterTier
         */
        Builder tier(ParameterTier tier);
    }

    static final class BuilderImpl extends SsmResponse.BuilderImpl implements Builder {
        private Long version;

        private String tier;

        private BuilderImpl() {
        }

        private BuilderImpl(PutParameterResponse model) {
            super(model);
            version(model.version);
            tier(model.tier);
        }

        public final Long getVersion() {
            return version;
        }

        @Override
        public final Builder version(Long version) {
            this.version = version;
            return this;
        }

        public final void setVersion(Long version) {
            this.version = version;
        }

        public final String getTier() {
            return tier;
        }

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

        @Override
        public final Builder tier(ParameterTier tier) {
            this.tier(tier == null ? null : tier.toString());
            return this;
        }

        public final void setTier(String tier) {
            this.tier = tier;
        }

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

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