software.amazon.awssdk.services.iotsitewise.model.DeleteTimeSeriesRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of iotsitewise Show documentation
The AWS Java SDK for Io T Site Wise module holds the client classes that are used for communicating with Io T Site Wise.
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.iotsitewise.model;

import java.util.Arrays;
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.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.DefaultValueTrait;
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 DeleteTimeSeriesRequest extends IoTSiteWiseRequest implements
        ToCopyableBuilder {
    private static final SdkField ALIAS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("alias")
            .getter(getter(DeleteTimeSeriesRequest::alias)).setter(setter(Builder::alias))
            .traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("alias").build()).build();

    private static final SdkField ASSET_ID_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("assetId").getter(getter(DeleteTimeSeriesRequest::assetId)).setter(setter(Builder::assetId))
            .traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("assetId").build()).build();

    private static final SdkField PROPERTY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("propertyId").getter(getter(DeleteTimeSeriesRequest::propertyId)).setter(setter(Builder::propertyId))
            .traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("propertyId").build()).build();

    private static final SdkField CLIENT_TOKEN_FIELD = SdkField
            . builder(MarshallingType.STRING)
            .memberName("clientToken")
            .getter(getter(DeleteTimeSeriesRequest::clientToken))
            .setter(setter(Builder::clientToken))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("clientToken").build(),
                    DefaultValueTrait.idempotencyToken()).build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ALIAS_FIELD, ASSET_ID_FIELD,
            PROPERTY_ID_FIELD, CLIENT_TOKEN_FIELD));

    private static final Map> SDK_NAME_TO_FIELD = Collections
            .unmodifiableMap(new HashMap>() {
                {
                    put("alias", ALIAS_FIELD);
                    put("assetId", ASSET_ID_FIELD);
                    put("propertyId", PROPERTY_ID_FIELD);
                    put("clientToken", CLIENT_TOKEN_FIELD);
                }
            });

    private final String alias;

    private final String assetId;

    private final String propertyId;

    private final String clientToken;

    private DeleteTimeSeriesRequest(BuilderImpl builder) {
        super(builder);
        this.alias = builder.alias;
        this.assetId = builder.assetId;
        this.propertyId = builder.propertyId;
        this.clientToken = builder.clientToken;
    }

    /**
     * 
     * The alias that identifies the time series.
     * 
     * 
     * @return The alias that identifies the time series.
     */
    public final String alias() {
        return alias;
    }

    /**
     * 
     * The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or
     * else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
     * 
     * 
     * @return The ID of the asset in which the asset property was created. This can be either the actual ID in UUID
     *         format, or else externalId: followed by the external ID, if it has one. For more
     *         information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
     */
    public final String assetId() {
        return assetId;
    }

    /**
     * 
     * The ID of the asset property. This can be either the actual ID in UUID format, or else externalId:
     * followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
     * 
     * 
     * @return The ID of the asset property. This can be either the actual ID in UUID format, or else
     *         externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
     */
    public final String propertyId() {
        return propertyId;
    }

    /**
     * 
     * A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse
     * this client token if a new idempotent request is required.
     * 
     * 
     * @return A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't
     *         reuse this client token if a new idempotent request is required.
     */
    public final String clientToken() {
        return clientToken;
    }

    @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(alias());
        hashCode = 31 * hashCode + Objects.hashCode(assetId());
        hashCode = 31 * hashCode + Objects.hashCode(propertyId());
        hashCode = 31 * hashCode + Objects.hashCode(clientToken());
        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 DeleteTimeSeriesRequest)) {
            return false;
        }
        DeleteTimeSeriesRequest other = (DeleteTimeSeriesRequest) obj;
        return Objects.equals(alias(), other.alias()) && Objects.equals(assetId(), other.assetId())
                && Objects.equals(propertyId(), other.propertyId()) && Objects.equals(clientToken(), other.clientToken());
    }

    /**
     * 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("DeleteTimeSeriesRequest").add("Alias", alias()).add("AssetId", assetId())
                .add("PropertyId", propertyId()).add("ClientToken", clientToken()).build();
    }

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

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

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

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

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

    public interface Builder extends IoTSiteWiseRequest.Builder, SdkPojo, CopyableBuilder {
        /**
         * 
         * The alias that identifies the time series.
         * 
         * 
         * @param alias
         *        The alias that identifies the time series.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder alias(String alias);

        /**
         * 
         * The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format,
         * or else externalId: followed by the external ID, if it has one. For more information, see 
         * Referencing objects with external IDs in the IoT SiteWise User Guide.
         * 
         * 
         * @param assetId
         *        The ID of the asset in which the asset property was created. This can be either the actual ID in UUID
         *        format, or else externalId: followed by the external ID, if it has one. For more
         *        information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder assetId(String assetId);

        /**
         * 
         * The ID of the asset property. This can be either the actual ID in UUID format, or else
         * externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
         * 
         * 
         * @param propertyId
         *        The ID of the asset property. This can be either the actual ID in UUID format, or else
         *        externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder propertyId(String propertyId);

        /**
         * 
         * A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse
         * this client token if a new idempotent request is required.
         * 
         * 
         * @param clientToken
         *        A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
         *        Don't reuse this client token if a new idempotent request is required.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder clientToken(String clientToken);

        @Override
        Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);

        @Override
        Builder overrideConfiguration(Consumer builderConsumer);
    }

    static final class BuilderImpl extends IoTSiteWiseRequest.BuilderImpl implements Builder {
        private String alias;

        private String assetId;

        private String propertyId;

        private String clientToken;

        private BuilderImpl() {
        }

        private BuilderImpl(DeleteTimeSeriesRequest model) {
            super(model);
            alias(model.alias);
            assetId(model.assetId);
            propertyId(model.propertyId);
            clientToken(model.clientToken);
        }

        public final String getAlias() {
            return alias;
        }

        public final void setAlias(String alias) {
            this.alias = alias;
        }

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

        public final String getAssetId() {
            return assetId;
        }

        public final void setAssetId(String assetId) {
            this.assetId = assetId;
        }

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

        public final String getPropertyId() {
            return propertyId;
        }

        public final void setPropertyId(String propertyId) {
            this.propertyId = propertyId;
        }

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

        public final String getClientToken() {
            return clientToken;
        }

        public final void setClientToken(String clientToken) {
            this.clientToken = clientToken;
        }

        @Override
        public final Builder clientToken(String clientToken) {
            this.clientToken = clientToken;
            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 DeleteTimeSeriesRequest build() {
            return new DeleteTimeSeriesRequest(this);
        }

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

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