/* * 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.AmazonWebServiceRequest; /** * * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class RegisterAppInstanceUserEndpointRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The ARN of the AppInstanceUser.
*
* The name of the AppInstanceUserEndpoint.
*
* The type of the AppInstanceUserEndpoint. Supported types:
*
* APNS: The mobile notification service for an Apple device.
*
* APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.
*
* GCM: The mobile notification service for an Android device.
*
* Populate the ResourceArn value of each type as PinpointAppArn.
*
* The ARN of the resource to which the endpoint belongs. *
*/ private String resourceArn; /** *
* The attributes of an Endpoint.
*
* The unique ID assigned to the request. Use different tokens to register other endpoints. *
*/ private String clientRequestToken; /** *
* Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL
* indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.
*
* 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 RegisterAppInstanceUserEndpointRequest withAppInstanceUserArn(String appInstanceUserArn) {
setAppInstanceUserArn(appInstanceUserArn);
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 RegisterAppInstanceUserEndpointRequest withName(String name) {
setName(name);
return this;
}
/**
*
* The type of the AppInstanceUserEndpoint. Supported types:
*
* APNS: The mobile notification service for an Apple device.
*
* APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.
*
* GCM: The mobile notification service for an Android device.
*
* Populate the ResourceArn value of each type as PinpointAppArn.
*
AppInstanceUserEndpoint. Supported types:
*
* APNS: The mobile notification service for an Apple device.
*
* APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.
*
* GCM: The mobile notification service for an Android device.
*
* Populate the ResourceArn value of each type as PinpointAppArn.
* @see AppInstanceUserEndpointType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The type of the AppInstanceUserEndpoint. Supported types:
*
* APNS: The mobile notification service for an Apple device.
*
* APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.
*
* GCM: The mobile notification service for an Android device.
*
* Populate the ResourceArn value of each type as PinpointAppArn.
*
AppInstanceUserEndpoint. Supported types:
*
* APNS: The mobile notification service for an Apple device.
*
* APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple
* device.
*
* GCM: The mobile notification service for an Android device.
*
* Populate the ResourceArn value of each type as PinpointAppArn.
* @see AppInstanceUserEndpointType
*/
public String getType() {
return this.type;
}
/**
*
* The type of the AppInstanceUserEndpoint. Supported types:
*
* APNS: The mobile notification service for an Apple device.
*
* APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.
*
* GCM: The mobile notification service for an Android device.
*
* Populate the ResourceArn value of each type as PinpointAppArn.
*
AppInstanceUserEndpoint. Supported types:
*
* APNS: The mobile notification service for an Apple device.
*
* APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.
*
* GCM: The mobile notification service for an Android device.
*
* Populate the ResourceArn value of each type as PinpointAppArn.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AppInstanceUserEndpointType
*/
public RegisterAppInstanceUserEndpointRequest withType(String type) {
setType(type);
return this;
}
/**
*
* The type of the AppInstanceUserEndpoint. Supported types:
*
* APNS: The mobile notification service for an Apple device.
*
* APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.
*
* GCM: The mobile notification service for an Android device.
*
* Populate the ResourceArn value of each type as PinpointAppArn.
*
AppInstanceUserEndpoint. Supported types:
*
* APNS: The mobile notification service for an Apple device.
*
* APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.
*
* GCM: The mobile notification service for an Android device.
*
* Populate the ResourceArn value of each type as PinpointAppArn.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AppInstanceUserEndpointType
*/
public RegisterAppInstanceUserEndpointRequest 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 RegisterAppInstanceUserEndpointRequest 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 RegisterAppInstanceUserEndpointRequest withEndpointAttributes(EndpointAttributes endpointAttributes) {
setEndpointAttributes(endpointAttributes);
return this;
}
/**
* * The unique ID assigned to the request. Use different tokens to register other endpoints. *
* * @param clientRequestToken * The unique ID assigned to the request. Use different tokens to register other endpoints. */ public void setClientRequestToken(String clientRequestToken) { this.clientRequestToken = clientRequestToken; } /** ** The unique ID assigned to the request. Use different tokens to register other endpoints. *
* * @return The unique ID assigned to the request. Use different tokens to register other endpoints. */ public String getClientRequestToken() { return this.clientRequestToken; } /** ** The unique ID assigned to the request. Use different tokens to register other endpoints. *
* * @param clientRequestToken * The unique ID assigned to the request. Use different tokens to register other endpoints. * @return Returns a reference to this object so that method calls can be chained together. */ public RegisterAppInstanceUserEndpointRequest withClientRequestToken(String clientRequestToken) { setClientRequestToken(clientRequestToken); return this; } /** *
* Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL
* indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.
*
ALL indicates the endpoint receives all messages. NONE indicates the endpoint
* receives 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 receives all messages. NONE indicates the endpoint receives no messages.
*
ALL indicates the endpoint receives all messages. NONE indicates the endpoint
* receives 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 receives all messages. NONE indicates the endpoint receives no messages.
*
ALL indicates the endpoint receives all messages. NONE indicates the endpoint
* receives no messages.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AllowMessages
*/
public RegisterAppInstanceUserEndpointRequest withAllowMessages(String allowMessages) {
setAllowMessages(allowMessages);
return this;
}
/**
*
* Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL
* indicates the endpoint receives all messages. NONE indicates the endpoint receives no messages.
*
ALL indicates the endpoint receives all messages. NONE indicates the endpoint
* receives no messages.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AllowMessages
*/
public RegisterAppInstanceUserEndpointRequest withAllowMessages(AllowMessages allowMessages) {
this.allowMessages = allowMessages.toString();
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("***Sensitive Data Redacted***").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 (getClientRequestToken() != null)
sb.append("ClientRequestToken: ").append(getClientRequestToken()).append(",");
if (getAllowMessages() != null)
sb.append("AllowMessages: ").append(getAllowMessages());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RegisterAppInstanceUserEndpointRequest == false)
return false;
RegisterAppInstanceUserEndpointRequest other = (RegisterAppInstanceUserEndpointRequest) obj;
if (other.getAppInstanceUserArn() == null ^ this.getAppInstanceUserArn() == null)
return false;
if (other.getAppInstanceUserArn() != null && other.getAppInstanceUserArn().equals(this.getAppInstanceUserArn()) == 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.getClientRequestToken() == null ^ this.getClientRequestToken() == null)
return false;
if (other.getClientRequestToken() != null && other.getClientRequestToken().equals(this.getClientRequestToken()) == false)
return false;
if (other.getAllowMessages() == null ^ this.getAllowMessages() == null)
return false;
if (other.getAllowMessages() != null && other.getAllowMessages().equals(this.getAllowMessages()) == 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 + ((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 + ((getClientRequestToken() == null) ? 0 : getClientRequestToken().hashCode());
hashCode = prime * hashCode + ((getAllowMessages() == null) ? 0 : getAllowMessages().hashCode());
return hashCode;
}
@Override
public RegisterAppInstanceUserEndpointRequest clone() {
return (RegisterAppInstanceUserEndpointRequest) super.clone();
}
}