software.amazon.awssdk.services.iotanalytics.model.DescribeChannelRequest 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.iotanalytics.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.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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 DescribeChannelRequest extends IoTAnalyticsRequest implements
        ToCopyableBuilder {
    private static final SdkField CHANNEL_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
            .getter(getter(DescribeChannelRequest::channelName)).setter(setter(Builder::channelName))
            .traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("channelName").build()).build();

    private static final SdkField INCLUDE_STATISTICS_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
            .getter(getter(DescribeChannelRequest::includeStatistics)).setter(setter(Builder::includeStatistics))
            .traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("includeStatistics").build())
            .build();

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

    private final String channelName;

    private final Boolean includeStatistics;

    private DescribeChannelRequest(BuilderImpl builder) {
        super(builder);
        this.channelName = builder.channelName;
        this.includeStatistics = builder.includeStatistics;
    }

    /**
     * 
     * The name of the channel whose information is retrieved.
     * 
     * 
     * @return The name of the channel whose information is retrieved.
     */
    public String channelName() {
        return channelName;
    }

    /**
     * 
     * If true, additional statistical information about the channel is included in the response. This feature cannot be
     * used with a channel whose S3 storage is customer-managed.
     * 
     * 
     * @return If true, additional statistical information about the channel is included in the response. This feature
     *         cannot be used with a channel whose S3 storage is customer-managed.
     */
    public Boolean includeStatistics() {
        return includeStatistics;
    }

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

    /**
     * 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("DescribeChannelRequest").add("ChannelName", channelName())
                .add("IncludeStatistics", includeStatistics()).build();
    }

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

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

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

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

    public interface Builder extends IoTAnalyticsRequest.Builder, SdkPojo, CopyableBuilder {
        /**
         * 
         * The name of the channel whose information is retrieved.
         * 
         * 
         * @param channelName
         *        The name of the channel whose information is retrieved.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder channelName(String channelName);

        /**
         * 
         * If true, additional statistical information about the channel is included in the response. This feature
         * cannot be used with a channel whose S3 storage is customer-managed.
         * 
         * 
         * @param includeStatistics
         *        If true, additional statistical information about the channel is included in the response. This
         *        feature cannot be used with a channel whose S3 storage is customer-managed.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder includeStatistics(Boolean includeStatistics);

        @Override
        Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);

        @Override
        Builder overrideConfiguration(Consumer builderConsumer);
    }

    static final class BuilderImpl extends IoTAnalyticsRequest.BuilderImpl implements Builder {
        private String channelName;

        private Boolean includeStatistics;

        private BuilderImpl() {
        }

        private BuilderImpl(DescribeChannelRequest model) {
            super(model);
            channelName(model.channelName);
            includeStatistics(model.includeStatistics);
        }

        public final String getChannelName() {
            return channelName;
        }

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

        public final void setChannelName(String channelName) {
            this.channelName = channelName;
        }

        public final Boolean getIncludeStatistics() {
            return includeStatistics;
        }

        @Override
        public final Builder includeStatistics(Boolean includeStatistics) {
            this.includeStatistics = includeStatistics;
            return this;
        }

        public final void setIncludeStatistics(Boolean includeStatistics) {
            this.includeStatistics = includeStatistics;
        }

        @Override
        public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
            super.overrideConfiguration(overrideConfiguration);
            return this;
        }

        @Override
        public Builder overrideConfiguration(Consumer builderConsumer) {
            super.overrideConfiguration(builderConsumer);
            return this;
        }

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

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