/* * 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; /** *

* Summary of the messages in a Channel. *

*/ public class ChannelMessageSummary implements Serializable { /** *

* The ID of the message. *

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

* The content of the channel message. For Amazon Lex V2 bot responses, this * field holds a list of messages originating from the bot. For more * information, refer to Processing responses from an AppInstanceBot in the Amazon Chime * SDK Messaging Developer Guide. *

* Constraints:
* Length: 0 - 4096
* Pattern: [\s\S]*
*/ private String content; /** *

* The metadata of the message. *

* Constraints:
* Length: 0 - 1024
* Pattern: .*
*/ private String metadata; /** *

* The type of message. *

* Constraints:
* Allowed Values: STANDARD, CONTROL */ private String type; /** *

* The time at which the message summary was created. *

*/ private java.util.Date createdTimestamp; /** *

* The time at which a message was last updated. *

*/ private java.util.Date lastUpdatedTimestamp; /** *

* The time at which a message was last edited. *

*/ private java.util.Date lastEditedTimestamp; /** *

* The message sender. *

*/ private Identity sender; /** *

* Indicates whether a message was redacted. *

*/ private Boolean redacted; /** *

* The message status. The status value is SENT for messages * sent to a channel without a channel flow. For channels associated with * channel flow, the value determines the processing stage. *

*/ private ChannelMessageStatusStructure status; /** *

* The attributes for the channel message. For Amazon Lex V2 bot responses, * the attributes are mapped to specific fields from the bot. For more * information, refer to Processing responses from an AppInstanceBot in the Amazon Chime * SDK Messaging Developer Guide. *

*/ private java.util.Map messageAttributes; /** *

* The content type of the channel message listed in the summary. For Amazon * Lex V2 bot responses, the content type is * application/amz-chime-lex-msgs for success responses and * application/amz-chime-lex-error for failure responses. For * more information, refer to Processing responses from an AppInstanceBot in the Amazon Chime * SDK Messaging Developer Guide. *

* Constraints:
* Length: 0 - 45
* Pattern: [\s\S]*
*/ private String contentType; /** *

* The target of a message, a sender, a user, or a bot. Only the target and * the sender can view targeted messages. Only users who can see targeted * messages can take actions on them. However, administrators can delete * targeted messages that they can’t see. *

*/ private java.util.List target; /** *

* 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 ChannelMessageSummary withMessageId(String messageId) { this.messageId = messageId; return this; } /** *

* Constraints:
* Length: 0 - 4096
* Pattern: [\s\S]*
* * @return

* The content of the channel message. For Amazon Lex V2 bot * responses, this field holds a list of messages originating from * the bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon * Chime SDK Messaging Developer Guide. *

*/ public String getContent() { return content; } /** *

* Constraints:
* Length: 0 - 4096
* Pattern: [\s\S]*
* * @param content

* The content of the channel message. For Amazon Lex V2 bot * responses, this field holds a list of messages originating * from the bot. For more information, refer to Processing responses from an AppInstanceBot in the * Amazon Chime SDK Messaging Developer Guide. *

*/ public void setContent(String content) { this.content = content; } /** *

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

* Constraints:
* Length: 0 - 4096
* Pattern: [\s\S]*
* * @param content

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

* The metadata of the message. *

* Constraints:
* Length: 0 - 1024
* Pattern: .*
* * @return

* The metadata of the message. *

*/ public String getMetadata() { return metadata; } /** *

* The metadata of the message. *

* Constraints:
* Length: 0 - 1024
* Pattern: .*
* * @param metadata

* The metadata of the message. *

*/ public void setMetadata(String metadata) { this.metadata = metadata; } /** *

* The metadata of the message. *

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

* Constraints:
* Length: 0 - 1024
* Pattern: .*
* * @param metadata

* The metadata of the message. *

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

* The type of message. *

* Constraints:
* Allowed Values: STANDARD, CONTROL * * @return

* The type of message. *

* @see ChannelMessageType */ public String getType() { return type; } /** *

* The type of message. *

* Constraints:
* Allowed Values: STANDARD, CONTROL * * @param type

* The type of message. *

* @see ChannelMessageType */ public void setType(String type) { this.type = type; } /** *

* The type of message. *

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

* Constraints:
* Allowed Values: STANDARD, CONTROL * * @param type

* The type of message. *

* @return A reference to this updated object so that method calls can be * chained together. * @see ChannelMessageType */ public ChannelMessageSummary withType(String type) { this.type = type; return this; } /** *

* The type of message. *

* Constraints:
* Allowed Values: STANDARD, CONTROL * * @param type

* The type of message. *

* @see ChannelMessageType */ public void setType(ChannelMessageType type) { this.type = type.toString(); } /** *

* The type of message. *

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

* Constraints:
* Allowed Values: STANDARD, CONTROL * * @param type

* The type of message. *

* @return A reference to this updated object so that method calls can be * chained together. * @see ChannelMessageType */ public ChannelMessageSummary withType(ChannelMessageType type) { this.type = type.toString(); return this; } /** *

* The time at which the message summary was created. *

* * @return

* The time at which the message summary was created. *

*/ public java.util.Date getCreatedTimestamp() { return createdTimestamp; } /** *

* The time at which the message summary was created. *

* * @param createdTimestamp

* The time at which the message summary was created. *

*/ public void setCreatedTimestamp(java.util.Date createdTimestamp) { this.createdTimestamp = createdTimestamp; } /** *

* The time at which the message summary was created. *

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

* The time at which the message summary was created. *

* @return A reference to this updated object so that method calls can be * chained together. */ public ChannelMessageSummary withCreatedTimestamp(java.util.Date createdTimestamp) { this.createdTimestamp = createdTimestamp; return this; } /** *

* The time at which a message was last updated. *

* * @return

* The time at which a message was last updated. *

*/ public java.util.Date getLastUpdatedTimestamp() { return lastUpdatedTimestamp; } /** *

* The time at which a message was last updated. *

* * @param lastUpdatedTimestamp

* The time at which a message was last updated. *

*/ public void setLastUpdatedTimestamp(java.util.Date lastUpdatedTimestamp) { this.lastUpdatedTimestamp = lastUpdatedTimestamp; } /** *

* The time at which a message was last updated. *

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

* The time at which a message was last updated. *

* @return A reference to this updated object so that method calls can be * chained together. */ public ChannelMessageSummary withLastUpdatedTimestamp(java.util.Date lastUpdatedTimestamp) { this.lastUpdatedTimestamp = lastUpdatedTimestamp; return this; } /** *

* The time at which a message was last edited. *

* * @return

* The time at which a message was last edited. *

*/ public java.util.Date getLastEditedTimestamp() { return lastEditedTimestamp; } /** *

* The time at which a message was last edited. *

* * @param lastEditedTimestamp

* The time at which a message was last edited. *

*/ public void setLastEditedTimestamp(java.util.Date lastEditedTimestamp) { this.lastEditedTimestamp = lastEditedTimestamp; } /** *

* The time at which a message was last edited. *

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

* The time at which a message was last edited. *

* @return A reference to this updated object so that method calls can be * chained together. */ public ChannelMessageSummary withLastEditedTimestamp(java.util.Date lastEditedTimestamp) { this.lastEditedTimestamp = lastEditedTimestamp; return this; } /** *

* The message sender. *

* * @return

* The message sender. *

*/ public Identity getSender() { return sender; } /** *

* The message sender. *

* * @param sender

* The message sender. *

*/ public void setSender(Identity sender) { this.sender = sender; } /** *

* The message sender. *

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

* The message sender. *

* @return A reference to this updated object so that method calls can be * chained together. */ public ChannelMessageSummary withSender(Identity sender) { this.sender = sender; return this; } /** *

* Indicates whether a message was redacted. *

* * @return

* Indicates whether a message was redacted. *

*/ public Boolean isRedacted() { return redacted; } /** *

* Indicates whether a message was redacted. *

* * @return

* Indicates whether a message was redacted. *

*/ public Boolean getRedacted() { return redacted; } /** *

* Indicates whether a message was redacted. *

* * @param redacted

* Indicates whether a message was redacted. *

*/ public void setRedacted(Boolean redacted) { this.redacted = redacted; } /** *

* Indicates whether a message was redacted. *

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

* Indicates whether a message was redacted. *

* @return A reference to this updated object so that method calls can be * chained together. */ public ChannelMessageSummary withRedacted(Boolean redacted) { this.redacted = redacted; return this; } /** *

* The message status. The status value is SENT for messages * sent to a channel without a channel flow. For channels associated with * channel flow, the value determines the processing stage. *

* * @return

* The message status. The status value is SENT for * messages sent to a channel without a channel flow. For channels * associated with channel flow, the value determines the processing * stage. *

*/ public ChannelMessageStatusStructure getStatus() { return status; } /** *

* The message status. The status value is SENT for messages * sent to a channel without a channel flow. For channels associated with * channel flow, the value determines the processing stage. *

* * @param status

* The message status. The status value is SENT for * messages sent to a channel without a channel flow. For * channels associated with channel flow, the value determines * the processing stage. *

*/ public void setStatus(ChannelMessageStatusStructure status) { this.status = status; } /** *

* The message status. The status value is SENT for messages * sent to a channel without a channel flow. For channels associated with * channel flow, the value determines the processing stage. *

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

* The message status. The status value is SENT for * messages sent to a channel without a channel flow. For * channels associated with channel flow, the value determines * the processing stage. *

* @return A reference to this updated object so that method calls can be * chained together. */ public ChannelMessageSummary withStatus(ChannelMessageStatusStructure status) { this.status = status; return this; } /** *

* * @return

* The attributes for the channel message. For Amazon Lex V2 bot * responses, the attributes are mapped to specific fields from the * bot. For more information, refer to Processing responses from an AppInstanceBot in the Amazon * Chime SDK Messaging Developer Guide. *

*/ public java.util.Map getMessageAttributes() { return messageAttributes; } /** *

* * @param messageAttributes

* The attributes for the channel message. For Amazon Lex V2 bot * responses, the attributes are mapped to specific fields from * the bot. For more information, refer to Processing responses from an AppInstanceBot in the * Amazon Chime SDK Messaging Developer Guide. *

*/ public void setMessageAttributes(java.util.Map messageAttributes) { this.messageAttributes = messageAttributes; } /** *

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

* @return A reference to this updated object so that method calls can be * chained together. */ public ChannelMessageSummary withMessageAttributes( java.util.Map messageAttributes) { this.messageAttributes = messageAttributes; return this; } /** *

* The method adds a new key-value pair into MessageAttributes parameter, * and returns a reference to this object so that method calls can be * chained together. * * @param key The key of the entry to be added into MessageAttributes. * @param value The corresponding value of the entry to be added into * MessageAttributes. * @return A reference to this updated object so that method calls can be * chained together. */ public ChannelMessageSummary addMessageAttributesEntry(String key, MessageAttributeValue value) { if (null == this.messageAttributes) { this.messageAttributes = new java.util.HashMap(); } if (this.messageAttributes.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.messageAttributes.put(key, value); return this; } /** * Removes all the entries added into MessageAttributes. *

* Returns a reference to this object so that method calls can be chained * together. */ public ChannelMessageSummary clearMessageAttributesEntries() { this.messageAttributes = null; return this; } /** *

* Constraints:
* Length: 0 - 45
* Pattern: [\s\S]*
* * @return

* The content type of the channel message listed in the summary. * For Amazon Lex V2 bot responses, the content type is * application/amz-chime-lex-msgs for success responses * and application/amz-chime-lex-error for failure * responses. For more information, refer to Processing responses from an AppInstanceBot in the Amazon * Chime SDK Messaging Developer Guide. *

*/ public String getContentType() { return contentType; } /** *

* Constraints:
* Length: 0 - 45
* Pattern: [\s\S]*
* * @param contentType

* The content type of the channel message listed in the summary. * For Amazon Lex V2 bot responses, the content type is * application/amz-chime-lex-msgs for success * responses and application/amz-chime-lex-error for * failure responses. For more information, refer to Processing responses from an AppInstanceBot in the * Amazon Chime SDK Messaging Developer Guide. *

*/ public void setContentType(String contentType) { this.contentType = contentType; } /** *

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

* Constraints:
* Length: 0 - 45
* Pattern: [\s\S]*
* * @param contentType

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

* * @return

* The target of a message, a sender, a user, or a bot. Only the * target and the sender can view targeted messages. Only users who * can see targeted messages can take actions on them. However, * administrators can delete targeted messages that they can’t see. *

*/ public java.util.List getTarget() { return target; } /** *

* * @param target

* The target of a message, a sender, a user, or a bot. Only the * target and the sender can view targeted messages. Only users * who can see targeted messages can take actions on them. * However, administrators can delete targeted messages that they * can’t see. *

*/ public void setTarget(java.util.Collection target) { if (target == null) { this.target = null; return; } this.target = new java.util.ArrayList(target); } /** *

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

* @return A reference to this updated object so that method calls can be * chained together. */ public ChannelMessageSummary withTarget(Target... target) { if (getTarget() == null) { this.target = new java.util.ArrayList(target.length); } for (Target value : target) { this.target.add(value); } return this; } /** *

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

* @return A reference to this updated object so that method calls can be * chained together. */ public ChannelMessageSummary withTarget(java.util.Collection target) { setTarget(target); 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 (getMessageId() != null) sb.append("MessageId: " + getMessageId() + ","); if (getContent() != null) sb.append("Content: " + getContent() + ","); if (getMetadata() != null) sb.append("Metadata: " + getMetadata() + ","); if (getType() != null) sb.append("Type: " + getType() + ","); if (getCreatedTimestamp() != null) sb.append("CreatedTimestamp: " + getCreatedTimestamp() + ","); if (getLastUpdatedTimestamp() != null) sb.append("LastUpdatedTimestamp: " + getLastUpdatedTimestamp() + ","); if (getLastEditedTimestamp() != null) sb.append("LastEditedTimestamp: " + getLastEditedTimestamp() + ","); if (getSender() != null) sb.append("Sender: " + getSender() + ","); if (getRedacted() != null) sb.append("Redacted: " + getRedacted() + ","); if (getStatus() != null) sb.append("Status: " + getStatus() + ","); if (getMessageAttributes() != null) sb.append("MessageAttributes: " + getMessageAttributes() + ","); if (getContentType() != null) sb.append("ContentType: " + getContentType() + ","); if (getTarget() != null) sb.append("Target: " + getTarget()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getMessageId() == null) ? 0 : getMessageId().hashCode()); hashCode = prime * hashCode + ((getContent() == null) ? 0 : getContent().hashCode()); hashCode = prime * hashCode + ((getMetadata() == null) ? 0 : getMetadata().hashCode()); hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode()); hashCode = prime * hashCode + ((getCreatedTimestamp() == null) ? 0 : getCreatedTimestamp().hashCode()); hashCode = prime * hashCode + ((getLastUpdatedTimestamp() == null) ? 0 : getLastUpdatedTimestamp().hashCode()); hashCode = prime * hashCode + ((getLastEditedTimestamp() == null) ? 0 : getLastEditedTimestamp().hashCode()); hashCode = prime * hashCode + ((getSender() == null) ? 0 : getSender().hashCode()); hashCode = prime * hashCode + ((getRedacted() == null) ? 0 : getRedacted().hashCode()); hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode()); hashCode = prime * hashCode + ((getMessageAttributes() == null) ? 0 : getMessageAttributes().hashCode()); hashCode = prime * hashCode + ((getContentType() == null) ? 0 : getContentType().hashCode()); hashCode = prime * hashCode + ((getTarget() == null) ? 0 : getTarget().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof ChannelMessageSummary == false) return false; ChannelMessageSummary other = (ChannelMessageSummary) obj; if (other.getMessageId() == null ^ this.getMessageId() == null) return false; if (other.getMessageId() != null && other.getMessageId().equals(this.getMessageId()) == false) return false; if (other.getContent() == null ^ this.getContent() == null) return false; if (other.getContent() != null && other.getContent().equals(this.getContent()) == false) return false; if (other.getMetadata() == null ^ this.getMetadata() == null) return false; if (other.getMetadata() != null && other.getMetadata().equals(this.getMetadata()) == false) return false; if (other.getType() == null ^ this.getType() == null) return false; if (other.getType() != null && other.getType().equals(this.getType()) == false) return false; if (other.getCreatedTimestamp() == null ^ this.getCreatedTimestamp() == null) return false; if (other.getCreatedTimestamp() != null && other.getCreatedTimestamp().equals(this.getCreatedTimestamp()) == false) return false; if (other.getLastUpdatedTimestamp() == null ^ this.getLastUpdatedTimestamp() == null) return false; if (other.getLastUpdatedTimestamp() != null && other.getLastUpdatedTimestamp().equals(this.getLastUpdatedTimestamp()) == false) return false; if (other.getLastEditedTimestamp() == null ^ this.getLastEditedTimestamp() == null) return false; if (other.getLastEditedTimestamp() != null && other.getLastEditedTimestamp().equals(this.getLastEditedTimestamp()) == false) return false; if (other.getSender() == null ^ this.getSender() == null) return false; if (other.getSender() != null && other.getSender().equals(this.getSender()) == false) return false; if (other.getRedacted() == null ^ this.getRedacted() == null) return false; if (other.getRedacted() != null && other.getRedacted().equals(this.getRedacted()) == false) return false; if (other.getStatus() == null ^ this.getStatus() == null) return false; if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false) return false; if (other.getMessageAttributes() == null ^ this.getMessageAttributes() == null) return false; if (other.getMessageAttributes() != null && other.getMessageAttributes().equals(this.getMessageAttributes()) == false) return false; if (other.getContentType() == null ^ this.getContentType() == null) return false; if (other.getContentType() != null && other.getContentType().equals(this.getContentType()) == false) return false; if (other.getTarget() == null ^ this.getTarget() == null) return false; if (other.getTarget() != null && other.getTarget().equals(this.getTarget()) == false) return false; return true; } }