/* * Copyright 2010-2023 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.chimesdkmessaging.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Gets message status for a specified messageId. Use this API to * determine the intermediate status of messages going through channel flow * processing. The API provides an alternative to retrieving message status if * the event was not received because a client wasn't connected to a websocket. *

*

* Messages can have any one of these statuses. *

*
*
SENT
*
*

* Message processed successfully *

*
*
PENDING
*
*

* Ongoing processing *

*
*
FAILED
*
*

* Processing failed *

*
*
DENIED
*
*

* Message denied by the processor *

*
*
* * * */ public class GetChannelMessageStatusRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The ARN of the channel *

*

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
*/ private String channelArn; /** *

* The ID of the message. *

*

* Constraints:
* Length: 1 - 128
* Pattern: [-_a-zA-Z0-9]*
*/ private String messageId; /** *

* The AppInstanceUserArn of the user making the API call. *

*

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
*/ private String chimeBearer; /** *

* The ID of the SubChannel in the request. *

* *

* Only required when getting message status in a SubChannel that the user * belongs to. *

* *

* Constraints:
* Length: 1 - 128
* Pattern: [-_a-zA-Z0-9]*
*/ private String subChannelId; /** *

* The ARN of the channel *

*

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
* * @return

* The ARN of the channel *

*/ public String getChannelArn() { return channelArn; } /** *

* The ARN of the channel *

*

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
* * @param channelArn

* The ARN of the channel *

*/ public void setChannelArn(String channelArn) { this.channelArn = channelArn; } /** *

* The ARN of the channel *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
* * @param channelArn

* The ARN of the channel *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetChannelMessageStatusRequest withChannelArn(String channelArn) { this.channelArn = channelArn; return this; } /** *

* The ID of the message. *

*

* Constraints:
* Length: 1 - 128
* Pattern: [-_a-zA-Z0-9]*
* * @return

* The ID of the message. *

*/ public String getMessageId() { return messageId; } /** *

* The ID of the message. *

*

* Constraints:
* Length: 1 - 128
* Pattern: [-_a-zA-Z0-9]*
* * @param messageId

* The ID of the message. *

*/ public void setMessageId(String messageId) { this.messageId = messageId; } /** *

* The ID of the message. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 128
* Pattern: [-_a-zA-Z0-9]*
* * @param messageId

* The ID of the message. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetChannelMessageStatusRequest withMessageId(String messageId) { this.messageId = messageId; return this; } /** *

* The AppInstanceUserArn of the user making the API call. *

*

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
* * @return

* The AppInstanceUserArn of the user making the API * call. *

*/ public String getChimeBearer() { return chimeBearer; } /** *

* The AppInstanceUserArn of the user making the API call. *

*

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
* * @param chimeBearer

* The AppInstanceUserArn of the user making the API * call. *

*/ public void setChimeBearer(String chimeBearer) { this.chimeBearer = chimeBearer; } /** *

* The AppInstanceUserArn of the user making the API call. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 5 - 1600
* Pattern: * arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}: * [a-z0-9-\.]{0,63}:[^/].{0,1023}
* * @param chimeBearer

* The AppInstanceUserArn of the user making the API * call. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetChannelMessageStatusRequest withChimeBearer(String chimeBearer) { this.chimeBearer = chimeBearer; return this; } /** *

* The ID of the SubChannel in the request. *

* *

* Only required when getting message status in a SubChannel that the user * belongs to. *

* *

* Constraints:
* Length: 1 - 128
* Pattern: [-_a-zA-Z0-9]*
* * @return

* The ID of the SubChannel in the request. *

* *

* Only required when getting message status in a SubChannel that * the user belongs to. *

* */ public String getSubChannelId() { return subChannelId; } /** *

* The ID of the SubChannel in the request. *

* *

* Only required when getting message status in a SubChannel that the user * belongs to. *

* *

* Constraints:
* Length: 1 - 128
* Pattern: [-_a-zA-Z0-9]*
* * @param subChannelId

* The ID of the SubChannel in the request. *

* *

* Only required when getting message status in a SubChannel that * the user belongs to. *

* */ public void setSubChannelId(String subChannelId) { this.subChannelId = subChannelId; } /** *

* The ID of the SubChannel in the request. *

* *

* Only required when getting message status in a SubChannel that the user * belongs to. *

* *

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 128
* Pattern: [-_a-zA-Z0-9]*
* * @param subChannelId

* The ID of the SubChannel in the request. *

* *

* Only required when getting message status in a SubChannel that * the user belongs to. *

* * @return A reference to this updated object so that method calls can be * chained together. */ public GetChannelMessageStatusRequest withSubChannelId(String subChannelId) { this.subChannelId = subChannelId; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getChannelArn() != null) sb.append("ChannelArn: " + getChannelArn() + ","); if (getMessageId() != null) sb.append("MessageId: " + getMessageId() + ","); if (getChimeBearer() != null) sb.append("ChimeBearer: " + getChimeBearer() + ","); if (getSubChannelId() != null) sb.append("SubChannelId: " + getSubChannelId()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getChannelArn() == null) ? 0 : getChannelArn().hashCode()); hashCode = prime * hashCode + ((getMessageId() == null) ? 0 : getMessageId().hashCode()); hashCode = prime * hashCode + ((getChimeBearer() == null) ? 0 : getChimeBearer().hashCode()); hashCode = prime * hashCode + ((getSubChannelId() == null) ? 0 : getSubChannelId().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetChannelMessageStatusRequest == false) return false; GetChannelMessageStatusRequest other = (GetChannelMessageStatusRequest) obj; if (other.getChannelArn() == null ^ this.getChannelArn() == null) return false; if (other.getChannelArn() != null && other.getChannelArn().equals(this.getChannelArn()) == false) return false; if (other.getMessageId() == null ^ this.getMessageId() == null) return false; if (other.getMessageId() != null && other.getMessageId().equals(this.getMessageId()) == false) return false; if (other.getChimeBearer() == null ^ this.getChimeBearer() == null) return false; if (other.getChimeBearer() != null && other.getChimeBearer().equals(this.getChimeBearer()) == false) return false; if (other.getSubChannelId() == null ^ this.getSubChannelId() == null) return false; if (other.getSubChannelId() != null && other.getSubChannelId().equals(this.getSubChannelId()) == false) return false; return true; } }