software.amazon.awssdk.services.location.model.BatchDeleteDevicePositionHistoryRequest 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.location.model;

import java.util.Arrays;
import java.util.Collection;
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.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;

/**
 */
@Generated("software.amazon.awssdk:codegen")
public final class BatchDeleteDevicePositionHistoryRequest extends LocationRequest implements
        ToCopyableBuilder {
    private static final SdkField> DEVICE_IDS_FIELD = SdkField
            .> builder(MarshallingType.LIST)
            .memberName("DeviceIds")
            .getter(getter(BatchDeleteDevicePositionHistoryRequest::deviceIds))
            .setter(setter(Builder::deviceIds))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeviceIds").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 SdkField TRACKER_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("TrackerName").getter(getter(BatchDeleteDevicePositionHistoryRequest::trackerName))
            .setter(setter(Builder::trackerName))
            .traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("TrackerName").build()).build();

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

    private final List deviceIds;

    private final String trackerName;

    private BatchDeleteDevicePositionHistoryRequest(BuilderImpl builder) {
        super(builder);
        this.deviceIds = builder.deviceIds;
        this.trackerName = builder.trackerName;
    }

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

    /**
     * 
     * Devices whose position history you want to delete.
     * 
     * 
     * 
     * 
     * For example, for two devices: “DeviceIds” : [DeviceId1,DeviceId2]
     * 
     * 
     * 
     * 
     * 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 #hasDeviceIds} method.
     * 
     * 
     * @return Devices whose position history you want to delete.
     *         
     *         
     *         
     *         For example, for two devices: “DeviceIds” : [DeviceId1,DeviceId2]
     *         
     *         
     */
    public final List deviceIds() {
        return deviceIds;
    }

    /**
     * 
     * The name of the tracker resource to delete the device position history from.
     * 
     * 
     * @return The name of the tracker resource to delete the device position history from.
     */
    public final String trackerName() {
        return trackerName;
    }

    @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 + super.hashCode();
        hashCode = 31 * hashCode + Objects.hashCode(hasDeviceIds() ? deviceIds() : null);
        hashCode = 31 * hashCode + Objects.hashCode(trackerName());
        return hashCode;
    }

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

    @Override
    public final boolean equalsBySdkFields(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (!(obj instanceof BatchDeleteDevicePositionHistoryRequest)) {
            return false;
        }
        BatchDeleteDevicePositionHistoryRequest other = (BatchDeleteDevicePositionHistoryRequest) obj;
        return hasDeviceIds() == other.hasDeviceIds() && Objects.equals(deviceIds(), other.deviceIds())
                && Objects.equals(trackerName(), other.trackerName());
    }

    /**
     * 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("BatchDeleteDevicePositionHistoryRequest").add("DeviceIds", hasDeviceIds() ? deviceIds() : null)
                .add("TrackerName", trackerName()).build();
    }

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

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

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

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

    public interface Builder extends LocationRequest.Builder, SdkPojo,
            CopyableBuilder {
        /**
         * 
         * Devices whose position history you want to delete.
         * 
         * 
         * 
         * 
         * For example, for two devices: “DeviceIds” : [DeviceId1,DeviceId2]
         * 
         * 
         * 
         * 
         * @param deviceIds
         *        Devices whose position history you want to delete.
         *        
         *        
         *        
         *        For example, for two devices: “DeviceIds” : [DeviceId1,DeviceId2]
         *        
         *        
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder deviceIds(Collection deviceIds);

        /**
         * 
         * Devices whose position history you want to delete.
         * 
         * 
         * 
         * 
         * For example, for two devices: “DeviceIds” : [DeviceId1,DeviceId2]
         * 
         * 
         * 
         * 
         * @param deviceIds
         *        Devices whose position history you want to delete.
         *        
         *        
         *        
         *        For example, for two devices: “DeviceIds” : [DeviceId1,DeviceId2]
         *        
         *        
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder deviceIds(String... deviceIds);

        /**
         * 
         * The name of the tracker resource to delete the device position history from.
         * 
         * 
         * @param trackerName
         *        The name of the tracker resource to delete the device position history from.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder trackerName(String trackerName);

        @Override
        Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);

        @Override
        Builder overrideConfiguration(Consumer builderConsumer);
    }

    static final class BuilderImpl extends LocationRequest.BuilderImpl implements Builder {
        private List deviceIds = DefaultSdkAutoConstructList.getInstance();

        private String trackerName;

        private BuilderImpl() {
        }

        private BuilderImpl(BatchDeleteDevicePositionHistoryRequest model) {
            super(model);
            deviceIds(model.deviceIds);
            trackerName(model.trackerName);
        }

        public final Collection getDeviceIds() {
            if (deviceIds instanceof SdkAutoConstructList) {
                return null;
            }
            return deviceIds;
        }

        public final void setDeviceIds(Collection deviceIds) {
            this.deviceIds = BatchDeleteDevicePositionHistoryRequestDeviceIdsListCopier.copy(deviceIds);
        }

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

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

        public final String getTrackerName() {
            return trackerName;
        }

        public final void setTrackerName(String trackerName) {
            this.trackerName = trackerName;
        }

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

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

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

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

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