software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sqs Show documentation
The AWS Java SDK for Amazon SQS module holds the client classes that are used for communicating with Amazon Simple Queue Service
There is a newer version: 2.29.39
Show 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.sqs.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.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 ChangeMessageVisibilityRequest extends SqsRequest implements
        ToCopyableBuilder {
    private static final SdkField QUEUE_URL_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("QueueUrl").getter(getter(ChangeMessageVisibilityRequest::queueUrl)).setter(setter(Builder::queueUrl))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("QueueUrl").build()).build();

    private static final SdkField RECEIPT_HANDLE_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("ReceiptHandle").getter(getter(ChangeMessageVisibilityRequest::receiptHandle))
            .setter(setter(Builder::receiptHandle))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReceiptHandle").build()).build();

    private static final SdkField VISIBILITY_TIMEOUT_FIELD = SdkField. builder(MarshallingType.INTEGER)
            .memberName("VisibilityTimeout").getter(getter(ChangeMessageVisibilityRequest::visibilityTimeout))
            .setter(setter(Builder::visibilityTimeout))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VisibilityTimeout").build()).build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(QUEUE_URL_FIELD,
            RECEIPT_HANDLE_FIELD, VISIBILITY_TIMEOUT_FIELD));

    private static final Map> SDK_NAME_TO_FIELD = Collections
            .unmodifiableMap(new HashMap>() {
                {
                    put("QueueUrl", QUEUE_URL_FIELD);
                    put("ReceiptHandle", RECEIPT_HANDLE_FIELD);
                    put("VisibilityTimeout", VISIBILITY_TIMEOUT_FIELD);
                }
            });

    private final String queueUrl;

    private final String receiptHandle;

    private final Integer visibilityTimeout;

    private ChangeMessageVisibilityRequest(BuilderImpl builder) {
        super(builder);
        this.queueUrl = builder.queueUrl;
        this.receiptHandle = builder.receiptHandle;
        this.visibilityTimeout = builder.visibilityTimeout;
    }

    /**
     * 
     * The URL of the Amazon SQS queue whose message's visibility is changed.
     * 
     * 
     * Queue URLs and names are case-sensitive.
     * 
     * 
     * @return The URL of the Amazon SQS queue whose message's visibility is changed.
     *         
     *         Queue URLs and names are case-sensitive.
     */
    public final String queueUrl() {
        return queueUrl;
    }

    /**
     * 

     * The receipt handle associated with the message, whose visibility timeout is changed. This parameter is returned
     * by the  ReceiveMessage  action.
     * 
     * 
     * @return The receipt handle associated with the message, whose visibility timeout is changed. This parameter is
     *         returned by the  ReceiveMessage  action.
     */
    public final String receiptHandle() {
        return receiptHandle;
    }

    /**
     * 
     * The new value for the message's visibility timeout (in seconds). Values range: 0 to
     * 43200. Maximum: 12 hours.
     * 
     * 
     * @return The new value for the message's visibility timeout (in seconds). Values range: 0 to
     *         43200. Maximum: 12 hours.
     */
    public final Integer visibilityTimeout() {
        return visibilityTimeout;
    }

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

    /**
     * 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("ChangeMessageVisibilityRequest").add("QueueUrl", queueUrl())
                .add("ReceiptHandle", receiptHandle()).add("VisibilityTimeout", visibilityTimeout()).build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "QueueUrl":
            return Optional.ofNullable(clazz.cast(queueUrl()));
        case "ReceiptHandle":
            return Optional.ofNullable(clazz.cast(receiptHandle()));
        case "VisibilityTimeout":
            return Optional.ofNullable(clazz.cast(visibilityTimeout()));
        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((ChangeMessageVisibilityRequest) obj);
    }

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

    public interface Builder extends SqsRequest.Builder, SdkPojo, CopyableBuilder {
        /**
         * 
         * The URL of the Amazon SQS queue whose message's visibility is changed.
         * 
         * 
         * Queue URLs and names are case-sensitive.
         * 
         * 
         * @param queueUrl
         *        The URL of the Amazon SQS queue whose message's visibility is changed.
         *        
         *        Queue URLs and names are case-sensitive.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder queueUrl(String queueUrl);

        /**
         * 

         * The receipt handle associated with the message, whose visibility timeout is changed. This parameter is
         * returned by the  ReceiveMessage  action.
         * 
         * 
         * @param receiptHandle
         *        The receipt handle associated with the message, whose visibility timeout is changed. This parameter is
         *        returned by the  ReceiveMessage  action.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder receiptHandle(String receiptHandle);

        /**
         * 
         * The new value for the message's visibility timeout (in seconds). Values range: 0 to
         * 43200. Maximum: 12 hours.
         * 
         * 
         * @param visibilityTimeout
         *        The new value for the message's visibility timeout (in seconds). Values range: 0 to
         *        43200. Maximum: 12 hours.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder visibilityTimeout(Integer visibilityTimeout);

        @Override
        Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);

        @Override
        Builder overrideConfiguration(Consumer builderConsumer);
    }

    static final class BuilderImpl extends SqsRequest.BuilderImpl implements Builder {
        private String queueUrl;

        private String receiptHandle;

        private Integer visibilityTimeout;

        private BuilderImpl() {
        }

        private BuilderImpl(ChangeMessageVisibilityRequest model) {
            super(model);
            queueUrl(model.queueUrl);
            receiptHandle(model.receiptHandle);
            visibilityTimeout(model.visibilityTimeout);
        }

        public final String getQueueUrl() {
            return queueUrl;
        }

        public final void setQueueUrl(String queueUrl) {
            this.queueUrl = queueUrl;
        }

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

        public final String getReceiptHandle() {
            return receiptHandle;
        }

        public final void setReceiptHandle(String receiptHandle) {
            this.receiptHandle = receiptHandle;
        }

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

        public final Integer getVisibilityTimeout() {
            return visibilityTimeout;
        }

        public final void setVisibilityTimeout(Integer visibilityTimeout) {
            this.visibilityTimeout = visibilityTimeout;
        }

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

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

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