software.amazon.awssdk.services.iot.model.JobExecutionsRolloutConfig 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.iot.model;

import java.beans.Transient;
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.Consumer;
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;

/**
 * 
 * Allows you to create a staged rollout of a job.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class JobExecutionsRolloutConfig implements SdkPojo, Serializable,
        ToCopyableBuilder {
    private static final SdkField MAXIMUM_PER_MINUTE_FIELD = SdkField. builder(MarshallingType.INTEGER)
            .memberName("maximumPerMinute").getter(getter(JobExecutionsRolloutConfig::maximumPerMinute))
            .setter(setter(Builder::maximumPerMinute))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("maximumPerMinute").build()).build();

    private static final SdkField EXPONENTIAL_RATE_FIELD = SdkField
            . builder(MarshallingType.SDK_POJO).memberName("exponentialRate")
            .getter(getter(JobExecutionsRolloutConfig::exponentialRate)).setter(setter(Builder::exponentialRate))
            .constructor(ExponentialRolloutRate::builder)
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("exponentialRate").build()).build();

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

    private static final long serialVersionUID = 1L;

    private final Integer maximumPerMinute;

    private final ExponentialRolloutRate exponentialRate;

    private JobExecutionsRolloutConfig(BuilderImpl builder) {
        this.maximumPerMinute = builder.maximumPerMinute;
        this.exponentialRate = builder.exponentialRate;
    }

    /**
     * 
     * The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to
     * create a staged rollout.
     * 
     * 
     * @return The maximum number of things that will be notified of a pending job, per minute. This parameter allows
     *         you to create a staged rollout.
     */
    public final Integer maximumPerMinute() {
        return maximumPerMinute;
    }

    /**
     * 
     * The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job
     * rollout.
     * 
     * 
     * @return The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job
     *         rollout.
     */
    public final ExponentialRolloutRate exponentialRate() {
        return exponentialRate;
    }

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

    /**
     * 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("JobExecutionsRolloutConfig").add("MaximumPerMinute", maximumPerMinute())
                .add("ExponentialRate", exponentialRate()).build();
    }

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

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

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

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

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to
         * create a staged rollout.
         * 
         * 
         * @param maximumPerMinute
         *        The maximum number of things that will be notified of a pending job, per minute. This parameter allows
         *        you to create a staged rollout.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder maximumPerMinute(Integer maximumPerMinute);

        /**
         * 
         * The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job
         * rollout.
         * 
         * 
         * @param exponentialRate
         *        The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a
         *        job rollout.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder exponentialRate(ExponentialRolloutRate exponentialRate);

        /**
         * 
         * The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job
         * rollout.
         * 
         * This is a convenience that creates an instance of the {@link ExponentialRolloutRate.Builder} avoiding the
         * need to create one manually via {@link ExponentialRolloutRate#builder()}.
         *
         * When the {@link Consumer} completes, {@link ExponentialRolloutRate.Builder#build()} is called immediately and
         * its result is passed to {@link #exponentialRate(ExponentialRolloutRate)}.
         * 
         * @param exponentialRate
         *        a consumer that will call methods on {@link ExponentialRolloutRate.Builder}
         * @return Returns a reference to this object so that method calls can be chained together.
         * @see #exponentialRate(ExponentialRolloutRate)
         */
        default Builder exponentialRate(Consumer exponentialRate) {
            return exponentialRate(ExponentialRolloutRate.builder().applyMutation(exponentialRate).build());
        }
    }

    static final class BuilderImpl implements Builder {
        private Integer maximumPerMinute;

        private ExponentialRolloutRate exponentialRate;

        private BuilderImpl() {
        }

        private BuilderImpl(JobExecutionsRolloutConfig model) {
            maximumPerMinute(model.maximumPerMinute);
            exponentialRate(model.exponentialRate);
        }

        public final Integer getMaximumPerMinute() {
            return maximumPerMinute;
        }

        public final void setMaximumPerMinute(Integer maximumPerMinute) {
            this.maximumPerMinute = maximumPerMinute;
        }

        @Override
        @Transient
        public final Builder maximumPerMinute(Integer maximumPerMinute) {
            this.maximumPerMinute = maximumPerMinute;
            return this;
        }

        public final ExponentialRolloutRate.Builder getExponentialRate() {
            return exponentialRate != null ? exponentialRate.toBuilder() : null;
        }

        public final void setExponentialRate(ExponentialRolloutRate.BuilderImpl exponentialRate) {
            this.exponentialRate = exponentialRate != null ? exponentialRate.build() : null;
        }

        @Override
        @Transient
        public final Builder exponentialRate(ExponentialRolloutRate exponentialRate) {
            this.exponentialRate = exponentialRate;
            return this;
        }

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

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