/* * Copyright 2018-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; 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.
*
* The ARN of the AppInstanceUser
.
*
* The unique identifier of the AppInstanceUserEndpoint
.
*
* The name of the AppInstanceUserEndpoint
.
*
* The type of the AppInstanceUserEndpoint
.
*
* The ARN of the resource to which the endpoint belongs. *
*/ private String resourceArn; /** *
* The attributes of an Endpoint
.
*
* The time at which an AppInstanceUserEndpoint
was created.
*
* The time at which an AppInstanceUserEndpoint
was last updated.
*
* 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.
*
* 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.
*
* The ARN of the AppInstanceUser
.
*
AppInstanceUser
.
*/
public void setAppInstanceUserArn(String appInstanceUserArn) {
this.appInstanceUserArn = appInstanceUserArn;
}
/**
*
* The ARN of the AppInstanceUser
.
*
AppInstanceUser
.
*/
public String getAppInstanceUserArn() {
return this.appInstanceUserArn;
}
/**
*
* The ARN of the AppInstanceUser
.
*
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
.
*
AppInstanceUserEndpoint
.
*/
public void setEndpointId(String endpointId) {
this.endpointId = endpointId;
}
/**
*
* The unique identifier of the AppInstanceUserEndpoint
.
*
AppInstanceUserEndpoint
.
*/
public String getEndpointId() {
return this.endpointId;
}
/**
*
* The unique identifier of the AppInstanceUserEndpoint
.
*
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
.
*
AppInstanceUserEndpoint
.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the AppInstanceUserEndpoint
.
*
AppInstanceUserEndpoint
.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the AppInstanceUserEndpoint
.
*
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
.
*
AppInstanceUserEndpoint
.
* @see AppInstanceUserEndpointType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The type of the AppInstanceUserEndpoint
.
*
AppInstanceUserEndpoint
.
* @see AppInstanceUserEndpointType
*/
public String getType() {
return this.type;
}
/**
*
* The type of the AppInstanceUserEndpoint
.
*
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
.
*
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
.
*
Endpoint
.
*/
public void setEndpointAttributes(EndpointAttributes endpointAttributes) {
this.endpointAttributes = endpointAttributes;
}
/**
*
* The attributes of an Endpoint
.
*
Endpoint
.
*/
public EndpointAttributes getEndpointAttributes() {
return this.endpointAttributes;
}
/**
*
* The attributes of an Endpoint
.
*
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.
*
AppInstanceUserEndpoint
was created.
*/
public void setCreatedTimestamp(java.util.Date createdTimestamp) {
this.createdTimestamp = createdTimestamp;
}
/**
*
* The time at which an AppInstanceUserEndpoint
was created.
*
AppInstanceUserEndpoint
was created.
*/
public java.util.Date getCreatedTimestamp() {
return this.createdTimestamp;
}
/**
*
* The time at which an AppInstanceUserEndpoint
was created.
*
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.
*
AppInstanceUserEndpoint
was last updated.
*/
public void setLastUpdatedTimestamp(java.util.Date lastUpdatedTimestamp) {
this.lastUpdatedTimestamp = lastUpdatedTimestamp;
}
/**
*
* The time at which an AppInstanceUserEndpoint
was last updated.
*
AppInstanceUserEndpoint
was last updated.
*/
public java.util.Date getLastUpdatedTimestamp() {
return this.lastUpdatedTimestamp;
}
/**
*
* The time at which an AppInstanceUserEndpoint
was last updated.
*
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.
*
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.
*
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.
*
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.
*
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.
*
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.
*
* 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.
*
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.
*
* 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.
*
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.
*