com.amazonaws.services.chimesdkidentity.model.AppInstanceUserEndpoint Maven / Gradle / Ivy
/*
* 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.chimesdkidentity.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* 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.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AppInstanceUserEndpoint implements Serializable, Cloneable, StructuredPojo {
/**
*
* The ARN of the AppInstanceUser.
*
*/
private String appInstanceUserArn;
/**
*
* The unique identifier of the AppInstanceUserEndpoint.
*
*/
private String endpointId;
/**
*
* The name of the AppInstanceUserEndpoint.
*
*/
private String name;
/**
*
* The type of the AppInstanceUserEndpoint.
*
*/
private String type;
/**
*
* The ARN of the resource to which the endpoint belongs.
*
*/
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.
*
*/
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.
*
*
* @param appInstanceUserArn
* The ARN of the AppInstanceUser.
*/
public void setAppInstanceUserArn(String appInstanceUserArn) {
this.appInstanceUserArn = appInstanceUserArn;
}
/**
*
* The ARN of the AppInstanceUser.
*
*
* @return The ARN of the AppInstanceUser.
*/
public String getAppInstanceUserArn() {
return this.appInstanceUserArn;
}
/**
*
* The ARN of the AppInstanceUser.
*
*
* @param appInstanceUserArn
* The ARN of the AppInstanceUser.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AppInstanceUserEndpoint withAppInstanceUserArn(String appInstanceUserArn) {
setAppInstanceUserArn(appInstanceUserArn);
return this;
}
/**
*
* The unique identifier of the AppInstanceUserEndpoint.
*
*
* @param endpointId
* The unique identifier of the AppInstanceUserEndpoint.
*/
public void setEndpointId(String endpointId) {
this.endpointId = endpointId;
}
/**
*
* The unique identifier of the AppInstanceUserEndpoint.
*
*
* @return The unique identifier of the AppInstanceUserEndpoint.
*/
public String getEndpointId() {
return this.endpointId;
}
/**
*
* The unique identifier of the AppInstanceUserEndpoint.
*
*
* @param endpointId
* The unique identifier of the AppInstanceUserEndpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AppInstanceUserEndpoint withEndpointId(String endpointId) {
setEndpointId(endpointId);
return this;
}
/**
*
* The name of the AppInstanceUserEndpoint.
*
*
* @param name
* The name of the AppInstanceUserEndpoint.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the AppInstanceUserEndpoint.
*
*
* @return The name of the AppInstanceUserEndpoint.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the AppInstanceUserEndpoint.
*
*
* @param name
* The name of the AppInstanceUserEndpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AppInstanceUserEndpoint withName(String name) {
setName(name);
return this;
}
/**
*
* The type of the AppInstanceUserEndpoint.
*
*
* @param type
* The type of the AppInstanceUserEndpoint.
* @see AppInstanceUserEndpointType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The type of the AppInstanceUserEndpoint.
*
*
* @return The type of the AppInstanceUserEndpoint.
* @see AppInstanceUserEndpointType
*/
public String getType() {
return this.type;
}
/**
*
* The type of the AppInstanceUserEndpoint.
*
*
* @param type
* The type of the AppInstanceUserEndpoint.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AppInstanceUserEndpointType
*/
public AppInstanceUserEndpoint withType(String type) {
setType(type);
return this;
}
/**
*
* The type of the AppInstanceUserEndpoint.
*
*
* @param type
* The type of the AppInstanceUserEndpoint.
* @return Returns a reference to this 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.
*
*
* @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.
*
*
* @return The ARN of the resource to which the endpoint belongs.
*/
public String getResourceArn() {
return this.resourceArn;
}
/**
*
* The ARN of the resource to which the endpoint belongs.
*
*
* @param resourceArn
* The ARN of the resource to which the endpoint belongs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AppInstanceUserEndpoint withResourceArn(String resourceArn) {
setResourceArn(resourceArn);
return this;
}
/**
*
* 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.
*
*
* @return The attributes of an Endpoint.
*/
public EndpointAttributes getEndpointAttributes() {
return this.endpointAttributes;
}
/**
*
* The attributes of an Endpoint.
*
*
* @param endpointAttributes
* The attributes of an Endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AppInstanceUserEndpoint withEndpointAttributes(EndpointAttributes endpointAttributes) {
setEndpointAttributes(endpointAttributes);
return this;
}
/**
*
* 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.
*
*
* @return The time at which an AppInstanceUserEndpoint was created.
*/
public java.util.Date getCreatedTimestamp() {
return this.createdTimestamp;
}
/**
*
* The time at which an AppInstanceUserEndpoint was created.
*
*
* @param createdTimestamp
* The time at which an AppInstanceUserEndpoint was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AppInstanceUserEndpoint withCreatedTimestamp(java.util.Date createdTimestamp) {
setCreatedTimestamp(createdTimestamp);
return this;
}
/**
*
* 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.
*
*
* @return The time at which an AppInstanceUserEndpoint was last updated.
*/
public java.util.Date getLastUpdatedTimestamp() {
return this.lastUpdatedTimestamp;
}
/**
*
* The time at which an AppInstanceUserEndpoint was last updated.
*
*
* @param lastUpdatedTimestamp
* The time at which an AppInstanceUserEndpoint was last updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AppInstanceUserEndpoint withLastUpdatedTimestamp(java.util.Date lastUpdatedTimestamp) {
setLastUpdatedTimestamp(lastUpdatedTimestamp);
return this;
}
/**
*
* 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.
*
*
* @param allowMessages
* 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 void setAllowMessages(String allowMessages) {
this.allowMessages = allowMessages;
}
/**
*
* 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.
*
*
* @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 this.allowMessages;
}
/**
*
* 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.
*
*
* @param allowMessages
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AllowMessages
*/
public AppInstanceUserEndpoint withAllowMessages(String allowMessages) {
setAllowMessages(allowMessages);
return this;
}
/**
*
* 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.
*
*
* @param allowMessages
* 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.
* @return Returns a reference to this 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.
*
*
*
*
* @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.
*
*
*
*
* @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 this.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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AppInstanceUserEndpoint withEndpointState(EndpointState endpointState) {
setEndpointState(endpointState);
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 (getAppInstanceUserArn() != null)
sb.append("AppInstanceUserArn: ").append(getAppInstanceUserArn()).append(",");
if (getEndpointId() != null)
sb.append("EndpointId: ").append(getEndpointId()).append(",");
if (getName() != null)
sb.append("Name: ").append("***Sensitive Data Redacted***").append(",");
if (getType() != null)
sb.append("Type: ").append(getType()).append(",");
if (getResourceArn() != null)
sb.append("ResourceArn: ").append(getResourceArn()).append(",");
if (getEndpointAttributes() != null)
sb.append("EndpointAttributes: ").append(getEndpointAttributes()).append(",");
if (getCreatedTimestamp() != null)
sb.append("CreatedTimestamp: ").append(getCreatedTimestamp()).append(",");
if (getLastUpdatedTimestamp() != null)
sb.append("LastUpdatedTimestamp: ").append(getLastUpdatedTimestamp()).append(",");
if (getAllowMessages() != null)
sb.append("AllowMessages: ").append(getAllowMessages()).append(",");
if (getEndpointState() != null)
sb.append("EndpointState: ").append(getEndpointState());
sb.append("}");
return sb.toString();
}
@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;
}
@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 AppInstanceUserEndpoint clone() {
try {
return (AppInstanceUserEndpoint) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.chimesdkidentity.model.transform.AppInstanceUserEndpointMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}