/* * 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.chimesdkidentity.model; import java.io.Serializable; /** *

* An endpoint under an Amazon Chime AppInstanceUser that receives * messages for a user. For push notifications, the endpoint is a mobile device * used to receive mobile push notifications for a user. *

*/ public class AppInstanceUserEndpoint implements Serializable { /** *

* The ARN of the AppInstanceUser. *

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

* The unique identifier of the AppInstanceUserEndpoint. *

* Constraints:
* Length: 0 - 64
* Pattern: .*
*/ private String endpointId; /** *

* The name of the AppInstanceUserEndpoint. *

* Constraints:
* Length: 0 - 1600
* Pattern: .*
*/ private String name; /** *

* The type of the AppInstanceUserEndpoint. *

* Constraints:
* Allowed Values: APNS, APNS_SANDBOX, GCM */ private String type; /** *

* The ARN of the resource to which the endpoint belongs. *

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

* The attributes of an Endpoint. *

*/ private EndpointAttributes endpointAttributes; /** *

* The time at which an AppInstanceUserEndpoint was created. *

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

* The time at which an AppInstanceUserEndpoint was last * updated. *

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

* Boolean that controls whether the AppInstanceUserEndpoint is * opted in to receive messages. ALL indicates the endpoint * will receive all messages. NONE indicates the endpoint will * receive no messages. *

* Constraints:
* Allowed Values: ALL, NONE */ private String allowMessages; /** *

* A read-only field that represents the state of an * AppInstanceUserEndpoint. Supported values: *

*
* ACTIVE: The AppInstanceUserEndpoint is active * and able to receive messages. When ACTIVE, the * EndpointStatusReason remains empty. *
*
*
* INACTIVE: The AppInstanceUserEndpoint is * inactive and can't receive message. When INACTIVE, the * corresponding reason will be conveyed through * EndpointStatusReason. *
*
*
* INVALID_DEVICE_TOKEN indicates that an * AppInstanceUserEndpoint is INACTIVE due to * invalid device token *
*
*
* INVALID_PINPOINT_ARN indicates that an * AppInstanceUserEndpoint is INACTIVE due to an * invalid pinpoint ARN that was input through the ResourceArn * field. *
*

*/ private EndpointState endpointState; /** *

* The ARN of the AppInstanceUser. *

* 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 AppInstanceUser. *

*/ public String getAppInstanceUserArn() { return appInstanceUserArn; } /** *

* The ARN of the AppInstanceUser. *

* 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 appInstanceUserArn

* The ARN of the AppInstanceUser. *

*/ public void setAppInstanceUserArn(String appInstanceUserArn) { this.appInstanceUserArn = appInstanceUserArn; } /** *

* The ARN of the AppInstanceUser. *

* 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 appInstanceUserArn

* The ARN of the AppInstanceUser. *

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

* The unique identifier of the AppInstanceUserEndpoint. *

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

* The unique identifier of the AppInstanceUserEndpoint * . *

*/ public String getEndpointId() { return endpointId; } /** *

* The unique identifier of the AppInstanceUserEndpoint. *

* Constraints:
* Length: 0 - 64
* Pattern: .*
* * @param endpointId

* The unique identifier of the * AppInstanceUserEndpoint. *

*/ public void setEndpointId(String endpointId) { this.endpointId = endpointId; } /** *

* The unique identifier of the AppInstanceUserEndpoint. *

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

* Constraints:
* Length: 0 - 64
* Pattern: .*
* * @param endpointId

* The unique identifier of the * AppInstanceUserEndpoint. *

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

* The name of the AppInstanceUserEndpoint. *

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

* The name of the AppInstanceUserEndpoint. *

*/ public String getName() { return name; } /** *

* The name of the AppInstanceUserEndpoint. *

* Constraints:
* Length: 0 - 1600
* Pattern: .*
* * @param name

* The name of the AppInstanceUserEndpoint. *

*/ public void setName(String name) { this.name = name; } /** *

* The name of the AppInstanceUserEndpoint. *

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

* Constraints:
* Length: 0 - 1600
* Pattern: .*
* * @param name

* The name of the AppInstanceUserEndpoint. *

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

* The type of the AppInstanceUserEndpoint. *

* Constraints:
* Allowed Values: APNS, APNS_SANDBOX, GCM * * @return

* The type of the AppInstanceUserEndpoint. *

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

* The type of the AppInstanceUserEndpoint. *

* Constraints:
* Allowed Values: APNS, APNS_SANDBOX, GCM * * @param type

* The type of the AppInstanceUserEndpoint. *

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

* The type of the AppInstanceUserEndpoint. *

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

* Constraints:
* Allowed Values: APNS, APNS_SANDBOX, GCM * * @param type

* The type of the AppInstanceUserEndpoint. *

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

* The type of the AppInstanceUserEndpoint. *

* Constraints:
* Allowed Values: APNS, APNS_SANDBOX, GCM * * @param type

* The type of the AppInstanceUserEndpoint. *

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

* The type of the AppInstanceUserEndpoint. *

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

* Constraints:
* Allowed Values: APNS, APNS_SANDBOX, GCM * * @param type

* The type of the AppInstanceUserEndpoint. *

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

* The ARN of the resource to which the endpoint belongs. *

* 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 resource to which the endpoint belongs. *

*/ public String getResourceArn() { return resourceArn; } /** *

* The ARN of the resource to which the endpoint belongs. *

* 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 resourceArn

* The ARN of the resource to which the endpoint belongs. *

*/ public void setResourceArn(String resourceArn) { this.resourceArn = resourceArn; } /** *

* The ARN of the resource to which the endpoint belongs. *

* 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 resourceArn

* The ARN of the resource to which the endpoint belongs. *

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

* The attributes of an Endpoint. *

* * @return

* The attributes of an Endpoint. *

*/ public EndpointAttributes getEndpointAttributes() { return endpointAttributes; } /** *

* The attributes of an Endpoint. *

* * @param endpointAttributes

* The attributes of an Endpoint. *

*/ public void setEndpointAttributes(EndpointAttributes endpointAttributes) { this.endpointAttributes = endpointAttributes; } /** *

* The attributes of an Endpoint. *

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

* The attributes of an Endpoint. *

* @return A reference to this updated object so that method calls can be * chained together. */ public AppInstanceUserEndpoint withEndpointAttributes(EndpointAttributes endpointAttributes) { this.endpointAttributes = endpointAttributes; return this; } /** *

* The time at which an AppInstanceUserEndpoint was created. *

* * @return

* The time at which an AppInstanceUserEndpoint was * created. *

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

* The time at which an AppInstanceUserEndpoint was created. *

* * @param createdTimestamp

* The time at which an AppInstanceUserEndpoint was * created. *

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

* The time at which an AppInstanceUserEndpoint was created. *

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

* The time at which an AppInstanceUserEndpoint was * created. *

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

* The time at which an AppInstanceUserEndpoint was last * updated. *

* * @return

* The time at which an AppInstanceUserEndpoint was * last updated. *

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

* The time at which an AppInstanceUserEndpoint was last * updated. *

* * @param lastUpdatedTimestamp

* The time at which an AppInstanceUserEndpoint was * last updated. *

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

* The time at which an AppInstanceUserEndpoint was last * updated. *

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

* The time at which an AppInstanceUserEndpoint was * last updated. *

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

* Constraints:
* Allowed Values: ALL, NONE * * @return

* Boolean that controls whether the * AppInstanceUserEndpoint is opted in to receive * messages. ALL indicates the endpoint will receive * all messages. NONE indicates the endpoint will * receive no messages. *

* @see AllowMessages */ public String getAllowMessages() { return allowMessages; } /** *

* Constraints:
* Allowed Values: ALL, NONE * * @param allowMessages

* @see AllowMessages */ public void setAllowMessages(String allowMessages) { this.allowMessages = allowMessages; } /** *

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

* Constraints:
* Allowed Values: ALL, NONE * * @param allowMessages

* @return A reference to this updated object so that method calls can be * chained together. * @see AllowMessages */ public AppInstanceUserEndpoint withAllowMessages(String allowMessages) { this.allowMessages = allowMessages; return this; } /** *

* Constraints:
* Allowed Values: ALL, NONE * * @param allowMessages

* @see AllowMessages */ public void setAllowMessages(AllowMessages allowMessages) { this.allowMessages = allowMessages.toString(); } /** *

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

* Constraints:
* Allowed Values: ALL, NONE * * @param allowMessages

* @return A reference to this updated object so that method calls can be * chained together. * @see AllowMessages */ public AppInstanceUserEndpoint withAllowMessages(AllowMessages allowMessages) { this.allowMessages = allowMessages.toString(); return this; } /** *

* A read-only field that represents the state of an * AppInstanceUserEndpoint. Supported values: *

*
* ACTIVE: The AppInstanceUserEndpoint is active * and able to receive messages. When ACTIVE, the * EndpointStatusReason remains empty. *
*
*
* INACTIVE: The AppInstanceUserEndpoint is * inactive and can't receive message. When INACTIVE, the * corresponding reason will be conveyed through * EndpointStatusReason. *
*
*
* INVALID_DEVICE_TOKEN indicates that an * AppInstanceUserEndpoint is INACTIVE due to * invalid device token *
*
*
* INVALID_PINPOINT_ARN indicates that an * AppInstanceUserEndpoint is INACTIVE due to an * invalid pinpoint ARN that was input through the ResourceArn * field. *
*

* * @return

* A read-only field that represents the state of an * AppInstanceUserEndpoint. Supported values: *

*
* ACTIVE: The AppInstanceUserEndpoint is * active and able to receive messages. When ACTIVE, * the EndpointStatusReason remains empty. *
*
*
* INACTIVE: The AppInstanceUserEndpoint * is inactive and can't receive message. When INACTIVE * , the corresponding reason will be conveyed through * EndpointStatusReason. *
*
*
* INVALID_DEVICE_TOKEN indicates that an * AppInstanceUserEndpoint is INACTIVE due * to invalid device token *
*
*
* INVALID_PINPOINT_ARN indicates that an * AppInstanceUserEndpoint is INACTIVE due * to an invalid pinpoint ARN that was input through the * ResourceArn field. *
*

*/ public EndpointState getEndpointState() { return endpointState; } /** *

* A read-only field that represents the state of an * AppInstanceUserEndpoint. Supported values: *

*
* ACTIVE: The AppInstanceUserEndpoint is active * and able to receive messages. When ACTIVE, the * EndpointStatusReason remains empty. *
*
*
* INACTIVE: The AppInstanceUserEndpoint is * inactive and can't receive message. When INACTIVE, the * corresponding reason will be conveyed through * EndpointStatusReason. *
*
*
* INVALID_DEVICE_TOKEN indicates that an * AppInstanceUserEndpoint is INACTIVE due to * invalid device token *
*
*
* INVALID_PINPOINT_ARN indicates that an * AppInstanceUserEndpoint is INACTIVE due to an * invalid pinpoint ARN that was input through the ResourceArn * field. *
*

* * @param endpointState

* A read-only field that represents the state of an * AppInstanceUserEndpoint. Supported values: *

*
* ACTIVE: The AppInstanceUserEndpoint * is active and able to receive messages. When * ACTIVE, the EndpointStatusReason * remains empty. *
*
*
* INACTIVE: The * AppInstanceUserEndpoint is inactive and can't * receive message. When INACTIVE, the corresponding * reason will be conveyed through * EndpointStatusReason. *
*
*
* INVALID_DEVICE_TOKEN indicates that an * AppInstanceUserEndpoint is INACTIVE * due to invalid device token *
*
*
* INVALID_PINPOINT_ARN indicates that an * AppInstanceUserEndpoint is INACTIVE * due to an invalid pinpoint ARN that was input through the * ResourceArn field. *
*

*/ public void setEndpointState(EndpointState endpointState) { this.endpointState = endpointState; } /** *

* A read-only field that represents the state of an * AppInstanceUserEndpoint. Supported values: *

*
* ACTIVE: The AppInstanceUserEndpoint is active * and able to receive messages. When ACTIVE, the * EndpointStatusReason remains empty. *
*
*
* INACTIVE: The AppInstanceUserEndpoint is * inactive and can't receive message. When INACTIVE, the * corresponding reason will be conveyed through * EndpointStatusReason. *
*
*
* INVALID_DEVICE_TOKEN indicates that an * AppInstanceUserEndpoint is INACTIVE due to * invalid device token *
*
*
* INVALID_PINPOINT_ARN indicates that an * AppInstanceUserEndpoint is INACTIVE due to an * invalid pinpoint ARN that was input through the ResourceArn * field. *
*

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

* A read-only field that represents the state of an * AppInstanceUserEndpoint. Supported values: *

*
* ACTIVE: The AppInstanceUserEndpoint * is active and able to receive messages. When * ACTIVE, the EndpointStatusReason * remains empty. *
*
*
* INACTIVE: The * AppInstanceUserEndpoint is inactive and can't * receive message. When INACTIVE, the corresponding * reason will be conveyed through * EndpointStatusReason. *
*
*
* INVALID_DEVICE_TOKEN indicates that an * AppInstanceUserEndpoint is INACTIVE * due to invalid device token *
*
*
* INVALID_PINPOINT_ARN indicates that an * AppInstanceUserEndpoint is INACTIVE * due to an invalid pinpoint ARN that was input through the * ResourceArn field. *
*

* @return A reference to this updated object so that method calls can be * chained together. */ public AppInstanceUserEndpoint withEndpointState(EndpointState endpointState) { this.endpointState = endpointState; 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 (getAppInstanceUserArn() != null) sb.append("AppInstanceUserArn: " + getAppInstanceUserArn() + ","); if (getEndpointId() != null) sb.append("EndpointId: " + getEndpointId() + ","); if (getName() != null) sb.append("Name: " + getName() + ","); if (getType() != null) sb.append("Type: " + getType() + ","); if (getResourceArn() != null) sb.append("ResourceArn: " + getResourceArn() + ","); if (getEndpointAttributes() != null) sb.append("EndpointAttributes: " + getEndpointAttributes() + ","); if (getCreatedTimestamp() != null) sb.append("CreatedTimestamp: " + getCreatedTimestamp() + ","); if (getLastUpdatedTimestamp() != null) sb.append("LastUpdatedTimestamp: " + getLastUpdatedTimestamp() + ","); if (getAllowMessages() != null) sb.append("AllowMessages: " + getAllowMessages() + ","); if (getEndpointState() != null) sb.append("EndpointState: " + getEndpointState()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getAppInstanceUserArn() == null) ? 0 : getAppInstanceUserArn().hashCode()); hashCode = prime * hashCode + ((getEndpointId() == null) ? 0 : getEndpointId().hashCode()); hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode()); hashCode = prime * hashCode + ((getResourceArn() == null) ? 0 : getResourceArn().hashCode()); hashCode = prime * hashCode + ((getEndpointAttributes() == null) ? 0 : getEndpointAttributes().hashCode()); hashCode = prime * hashCode + ((getCreatedTimestamp() == null) ? 0 : getCreatedTimestamp().hashCode()); hashCode = prime * hashCode + ((getLastUpdatedTimestamp() == null) ? 0 : getLastUpdatedTimestamp().hashCode()); hashCode = prime * hashCode + ((getAllowMessages() == null) ? 0 : getAllowMessages().hashCode()); hashCode = prime * hashCode + ((getEndpointState() == null) ? 0 : getEndpointState().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof AppInstanceUserEndpoint == false) return false; AppInstanceUserEndpoint other = (AppInstanceUserEndpoint) obj; if (other.getAppInstanceUserArn() == null ^ this.getAppInstanceUserArn() == null) return false; if (other.getAppInstanceUserArn() != null && other.getAppInstanceUserArn().equals(this.getAppInstanceUserArn()) == false) return false; if (other.getEndpointId() == null ^ this.getEndpointId() == null) return false; if (other.getEndpointId() != null && other.getEndpointId().equals(this.getEndpointId()) == false) return false; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == 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.getResourceArn() == null ^ this.getResourceArn() == null) return false; if (other.getResourceArn() != null && other.getResourceArn().equals(this.getResourceArn()) == false) return false; if (other.getEndpointAttributes() == null ^ this.getEndpointAttributes() == null) return false; if (other.getEndpointAttributes() != null && other.getEndpointAttributes().equals(this.getEndpointAttributes()) == 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.getAllowMessages() == null ^ this.getAllowMessages() == null) return false; if (other.getAllowMessages() != null && other.getAllowMessages().equals(this.getAllowMessages()) == false) return false; if (other.getEndpointState() == null ^ this.getEndpointState() == null) return false; if (other.getEndpointState() != null && other.getEndpointState().equals(this.getEndpointState()) == false) return false; return true; } }