com.amazonaws.services.sqs.model.ChangeMessageVisibilityRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sqs Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.sqs.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ChangeMessageVisibilityRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The URL of the Amazon SQS queue whose message's visibility is changed.
*
*
* Queue URLs and names are case-sensitive.
*
*/
private String queueUrl;
/**
*
* The receipt handle associated with the message, whose visibility timeout is changed. This parameter is returned
* by the ReceiveMessage action.
*
*/
private String receiptHandle;
/**
*
* The new value for the message's visibility timeout (in seconds). Values range: 0 to
* 43200. Maximum: 12 hours.
*
*/
private Integer visibilityTimeout;
/**
* Default constructor for ChangeMessageVisibilityRequest object. Callers should use the setter or fluent setter
* (with...) methods to initialize the object after creating it.
*/
public ChangeMessageVisibilityRequest() {
}
/**
* Constructs a new ChangeMessageVisibilityRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize any additional object members.
*
* @param queueUrl
* The URL of the Amazon SQS queue whose message's visibility is changed.
*
* Queue URLs and names are case-sensitive.
* @param receiptHandle
* The receipt handle associated with the message, whose visibility timeout is changed. This parameter is
* returned by the ReceiveMessage action.
* @param visibilityTimeout
* The new value for the message's visibility timeout (in seconds). Values range: 0 to
* 43200. Maximum: 12 hours.
*/
public ChangeMessageVisibilityRequest(String queueUrl, String receiptHandle, Integer visibilityTimeout) {
setQueueUrl(queueUrl);
setReceiptHandle(receiptHandle);
setVisibilityTimeout(visibilityTimeout);
}
/**
*
* 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.
*/
public void setQueueUrl(String queueUrl) {
this.queueUrl = queueUrl;
}
/**
*
* 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 String getQueueUrl() {
return this.queueUrl;
}
/**
*
* 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.
*/
public ChangeMessageVisibilityRequest withQueueUrl(String queueUrl) {
setQueueUrl(queueUrl);
return this;
}
/**
*
* 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.
*/
public void setReceiptHandle(String receiptHandle) {
this.receiptHandle = receiptHandle;
}
/**
*
* 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 String getReceiptHandle() {
return this.receiptHandle;
}
/**
*
* 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.
*/
public ChangeMessageVisibilityRequest withReceiptHandle(String receiptHandle) {
setReceiptHandle(receiptHandle);
return this;
}
/**
*
* 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.
*/
public void setVisibilityTimeout(Integer visibilityTimeout) {
this.visibilityTimeout = visibilityTimeout;
}
/**
*
* 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 Integer getVisibilityTimeout() {
return this.visibilityTimeout;
}
/**
*
* 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.
*/
public ChangeMessageVisibilityRequest withVisibilityTimeout(Integer visibilityTimeout) {
setVisibilityTimeout(visibilityTimeout);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getQueueUrl() != null)
sb.append("QueueUrl: ").append(getQueueUrl()).append(",");
if (getReceiptHandle() != null)
sb.append("ReceiptHandle: ").append(getReceiptHandle()).append(",");
if (getVisibilityTimeout() != null)
sb.append("VisibilityTimeout: ").append(getVisibilityTimeout());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ChangeMessageVisibilityRequest == false)
return false;
ChangeMessageVisibilityRequest other = (ChangeMessageVisibilityRequest) obj;
if (other.getQueueUrl() == null ^ this.getQueueUrl() == null)
return false;
if (other.getQueueUrl() != null && other.getQueueUrl().equals(this.getQueueUrl()) == false)
return false;
if (other.getReceiptHandle() == null ^ this.getReceiptHandle() == null)
return false;
if (other.getReceiptHandle() != null && other.getReceiptHandle().equals(this.getReceiptHandle()) == false)
return false;
if (other.getVisibilityTimeout() == null ^ this.getVisibilityTimeout() == null)
return false;
if (other.getVisibilityTimeout() != null && other.getVisibilityTimeout().equals(this.getVisibilityTimeout()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getQueueUrl() == null) ? 0 : getQueueUrl().hashCode());
hashCode = prime * hashCode + ((getReceiptHandle() == null) ? 0 : getReceiptHandle().hashCode());
hashCode = prime * hashCode + ((getVisibilityTimeout() == null) ? 0 : getVisibilityTimeout().hashCode());
return hashCode;
}
@Override
public ChangeMessageVisibilityRequest clone() {
return (ChangeMessageVisibilityRequest) super.clone();
}
}