com.amazonaws.services.alexaforbusiness.model.NetworkProfile Maven / Gradle / Ivy
Show all versions of aws-java-sdk-alexaforbusiness Show documentation
/*
* Copyright 2014-2019 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.alexaforbusiness.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The network profile associated with a device.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class NetworkProfile implements Serializable, Cloneable, StructuredPojo {
/**
*
* The ARN of the network profile associated with a device.
*
*/
private String networkProfileArn;
/**
*
* The name of the network profile associated with a device.
*
*/
private String networkProfileName;
/**
*
* Detailed information about a device's network profile.
*
*/
private String description;
/**
*
* The SSID of the Wi-Fi network.
*
*/
private String ssid;
/**
*
* The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
*
*/
private String securityType;
/**
*
* The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
*
*/
private String eapMethod;
/**
*
* The current password of the Wi-Fi network.
*
*/
private String currentPassword;
/**
*
* The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device
* and is used when the password of the network changes to NextPassword.
*
*/
private String nextPassword;
/**
*
* The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to
* issue certificates to the devices.
*
*/
private String certificateAuthorityArn;
/**
*
* The root certificates of your authentication server, which is installed on your devices and used to trust your
* authentication server during EAP negotiation.
*
*/
private java.util.List trustAnchors;
/**
*
* The ARN of the network profile associated with a device.
*
*
* @param networkProfileArn
* The ARN of the network profile associated with a device.
*/
public void setNetworkProfileArn(String networkProfileArn) {
this.networkProfileArn = networkProfileArn;
}
/**
*
* The ARN of the network profile associated with a device.
*
*
* @return The ARN of the network profile associated with a device.
*/
public String getNetworkProfileArn() {
return this.networkProfileArn;
}
/**
*
* The ARN of the network profile associated with a device.
*
*
* @param networkProfileArn
* The ARN of the network profile associated with a device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public NetworkProfile withNetworkProfileArn(String networkProfileArn) {
setNetworkProfileArn(networkProfileArn);
return this;
}
/**
*
* The name of the network profile associated with a device.
*
*
* @param networkProfileName
* The name of the network profile associated with a device.
*/
public void setNetworkProfileName(String networkProfileName) {
this.networkProfileName = networkProfileName;
}
/**
*
* The name of the network profile associated with a device.
*
*
* @return The name of the network profile associated with a device.
*/
public String getNetworkProfileName() {
return this.networkProfileName;
}
/**
*
* The name of the network profile associated with a device.
*
*
* @param networkProfileName
* The name of the network profile associated with a device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public NetworkProfile withNetworkProfileName(String networkProfileName) {
setNetworkProfileName(networkProfileName);
return this;
}
/**
*
* Detailed information about a device's network profile.
*
*
* @param description
* Detailed information about a device's network profile.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* Detailed information about a device's network profile.
*
*
* @return Detailed information about a device's network profile.
*/
public String getDescription() {
return this.description;
}
/**
*
* Detailed information about a device's network profile.
*
*
* @param description
* Detailed information about a device's network profile.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public NetworkProfile withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The SSID of the Wi-Fi network.
*
*
* @param ssid
* The SSID of the Wi-Fi network.
*/
public void setSsid(String ssid) {
this.ssid = ssid;
}
/**
*
* The SSID of the Wi-Fi network.
*
*
* @return The SSID of the Wi-Fi network.
*/
public String getSsid() {
return this.ssid;
}
/**
*
* The SSID of the Wi-Fi network.
*
*
* @param ssid
* The SSID of the Wi-Fi network.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public NetworkProfile withSsid(String ssid) {
setSsid(ssid);
return this;
}
/**
*
* The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
*
*
* @param securityType
* The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
* @see NetworkSecurityType
*/
public void setSecurityType(String securityType) {
this.securityType = securityType;
}
/**
*
* The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
*
*
* @return The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
* @see NetworkSecurityType
*/
public String getSecurityType() {
return this.securityType;
}
/**
*
* The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
*
*
* @param securityType
* The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
* @return Returns a reference to this object so that method calls can be chained together.
* @see NetworkSecurityType
*/
public NetworkProfile withSecurityType(String securityType) {
setSecurityType(securityType);
return this;
}
/**
*
* The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
*
*
* @param securityType
* The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
* @return Returns a reference to this object so that method calls can be chained together.
* @see NetworkSecurityType
*/
public NetworkProfile withSecurityType(NetworkSecurityType securityType) {
this.securityType = securityType.toString();
return this;
}
/**
*
* The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
*
*
* @param eapMethod
* The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
* @see NetworkEapMethod
*/
public void setEapMethod(String eapMethod) {
this.eapMethod = eapMethod;
}
/**
*
* The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
*
*
* @return The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
* @see NetworkEapMethod
*/
public String getEapMethod() {
return this.eapMethod;
}
/**
*
* The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
*
*
* @param eapMethod
* The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
* @return Returns a reference to this object so that method calls can be chained together.
* @see NetworkEapMethod
*/
public NetworkProfile withEapMethod(String eapMethod) {
setEapMethod(eapMethod);
return this;
}
/**
*
* The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
*
*
* @param eapMethod
* The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
* @return Returns a reference to this object so that method calls can be chained together.
* @see NetworkEapMethod
*/
public NetworkProfile withEapMethod(NetworkEapMethod eapMethod) {
this.eapMethod = eapMethod.toString();
return this;
}
/**
*
* The current password of the Wi-Fi network.
*
*
* @param currentPassword
* The current password of the Wi-Fi network.
*/
public void setCurrentPassword(String currentPassword) {
this.currentPassword = currentPassword;
}
/**
*
* The current password of the Wi-Fi network.
*
*
* @return The current password of the Wi-Fi network.
*/
public String getCurrentPassword() {
return this.currentPassword;
}
/**
*
* The current password of the Wi-Fi network.
*
*
* @param currentPassword
* The current password of the Wi-Fi network.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public NetworkProfile withCurrentPassword(String currentPassword) {
setCurrentPassword(currentPassword);
return this;
}
/**
*
* The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device
* and is used when the password of the network changes to NextPassword.
*
*
* @param nextPassword
* The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the
* device and is used when the password of the network changes to NextPassword.
*/
public void setNextPassword(String nextPassword) {
this.nextPassword = nextPassword;
}
/**
*
* The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device
* and is used when the password of the network changes to NextPassword.
*
*
* @return The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to
* the device and is used when the password of the network changes to NextPassword.
*/
public String getNextPassword() {
return this.nextPassword;
}
/**
*
* The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device
* and is used when the password of the network changes to NextPassword.
*
*
* @param nextPassword
* The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the
* device and is used when the password of the network changes to NextPassword.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public NetworkProfile withNextPassword(String nextPassword) {
setNextPassword(nextPassword);
return this;
}
/**
*
* The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to
* issue certificates to the devices.
*
*
* @param certificateAuthorityArn
* The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used
* to issue certificates to the devices.
*/
public void setCertificateAuthorityArn(String certificateAuthorityArn) {
this.certificateAuthorityArn = certificateAuthorityArn;
}
/**
*
* The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to
* issue certificates to the devices.
*
*
* @return The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used
* to issue certificates to the devices.
*/
public String getCertificateAuthorityArn() {
return this.certificateAuthorityArn;
}
/**
*
* The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to
* issue certificates to the devices.
*
*
* @param certificateAuthorityArn
* The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used
* to issue certificates to the devices.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public NetworkProfile withCertificateAuthorityArn(String certificateAuthorityArn) {
setCertificateAuthorityArn(certificateAuthorityArn);
return this;
}
/**
*
* The root certificates of your authentication server, which is installed on your devices and used to trust your
* authentication server during EAP negotiation.
*
*
* @return The root certificates of your authentication server, which is installed on your devices and used to trust
* your authentication server during EAP negotiation.
*/
public java.util.List getTrustAnchors() {
return trustAnchors;
}
/**
*
* The root certificates of your authentication server, which is installed on your devices and used to trust your
* authentication server during EAP negotiation.
*
*
* @param trustAnchors
* The root certificates of your authentication server, which is installed on your devices and used to trust
* your authentication server during EAP negotiation.
*/
public void setTrustAnchors(java.util.Collection trustAnchors) {
if (trustAnchors == null) {
this.trustAnchors = null;
return;
}
this.trustAnchors = new java.util.ArrayList(trustAnchors);
}
/**
*
* The root certificates of your authentication server, which is installed on your devices and used to trust your
* authentication server during EAP negotiation.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTrustAnchors(java.util.Collection)} or {@link #withTrustAnchors(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param trustAnchors
* The root certificates of your authentication server, which is installed on your devices and used to trust
* your authentication server during EAP negotiation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public NetworkProfile withTrustAnchors(String... trustAnchors) {
if (this.trustAnchors == null) {
setTrustAnchors(new java.util.ArrayList(trustAnchors.length));
}
for (String ele : trustAnchors) {
this.trustAnchors.add(ele);
}
return this;
}
/**
*
* The root certificates of your authentication server, which is installed on your devices and used to trust your
* authentication server during EAP negotiation.
*
*
* @param trustAnchors
* The root certificates of your authentication server, which is installed on your devices and used to trust
* your authentication server during EAP negotiation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public NetworkProfile withTrustAnchors(java.util.Collection trustAnchors) {
setTrustAnchors(trustAnchors);
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 (getNetworkProfileArn() != null)
sb.append("NetworkProfileArn: ").append(getNetworkProfileArn()).append(",");
if (getNetworkProfileName() != null)
sb.append("NetworkProfileName: ").append(getNetworkProfileName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getSsid() != null)
sb.append("Ssid: ").append(getSsid()).append(",");
if (getSecurityType() != null)
sb.append("SecurityType: ").append(getSecurityType()).append(",");
if (getEapMethod() != null)
sb.append("EapMethod: ").append(getEapMethod()).append(",");
if (getCurrentPassword() != null)
sb.append("CurrentPassword: ").append("***Sensitive Data Redacted***").append(",");
if (getNextPassword() != null)
sb.append("NextPassword: ").append("***Sensitive Data Redacted***").append(",");
if (getCertificateAuthorityArn() != null)
sb.append("CertificateAuthorityArn: ").append(getCertificateAuthorityArn()).append(",");
if (getTrustAnchors() != null)
sb.append("TrustAnchors: ").append(getTrustAnchors());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof NetworkProfile == false)
return false;
NetworkProfile other = (NetworkProfile) obj;
if (other.getNetworkProfileArn() == null ^ this.getNetworkProfileArn() == null)
return false;
if (other.getNetworkProfileArn() != null && other.getNetworkProfileArn().equals(this.getNetworkProfileArn()) == false)
return false;
if (other.getNetworkProfileName() == null ^ this.getNetworkProfileName() == null)
return false;
if (other.getNetworkProfileName() != null && other.getNetworkProfileName().equals(this.getNetworkProfileName()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getSsid() == null ^ this.getSsid() == null)
return false;
if (other.getSsid() != null && other.getSsid().equals(this.getSsid()) == false)
return false;
if (other.getSecurityType() == null ^ this.getSecurityType() == null)
return false;
if (other.getSecurityType() != null && other.getSecurityType().equals(this.getSecurityType()) == false)
return false;
if (other.getEapMethod() == null ^ this.getEapMethod() == null)
return false;
if (other.getEapMethod() != null && other.getEapMethod().equals(this.getEapMethod()) == false)
return false;
if (other.getCurrentPassword() == null ^ this.getCurrentPassword() == null)
return false;
if (other.getCurrentPassword() != null && other.getCurrentPassword().equals(this.getCurrentPassword()) == false)
return false;
if (other.getNextPassword() == null ^ this.getNextPassword() == null)
return false;
if (other.getNextPassword() != null && other.getNextPassword().equals(this.getNextPassword()) == false)
return false;
if (other.getCertificateAuthorityArn() == null ^ this.getCertificateAuthorityArn() == null)
return false;
if (other.getCertificateAuthorityArn() != null && other.getCertificateAuthorityArn().equals(this.getCertificateAuthorityArn()) == false)
return false;
if (other.getTrustAnchors() == null ^ this.getTrustAnchors() == null)
return false;
if (other.getTrustAnchors() != null && other.getTrustAnchors().equals(this.getTrustAnchors()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getNetworkProfileArn() == null) ? 0 : getNetworkProfileArn().hashCode());
hashCode = prime * hashCode + ((getNetworkProfileName() == null) ? 0 : getNetworkProfileName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getSsid() == null) ? 0 : getSsid().hashCode());
hashCode = prime * hashCode + ((getSecurityType() == null) ? 0 : getSecurityType().hashCode());
hashCode = prime * hashCode + ((getEapMethod() == null) ? 0 : getEapMethod().hashCode());
hashCode = prime * hashCode + ((getCurrentPassword() == null) ? 0 : getCurrentPassword().hashCode());
hashCode = prime * hashCode + ((getNextPassword() == null) ? 0 : getNextPassword().hashCode());
hashCode = prime * hashCode + ((getCertificateAuthorityArn() == null) ? 0 : getCertificateAuthorityArn().hashCode());
hashCode = prime * hashCode + ((getTrustAnchors() == null) ? 0 : getTrustAnchors().hashCode());
return hashCode;
}
@Override
public NetworkProfile clone() {
try {
return (NetworkProfile) 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.alexaforbusiness.model.transform.NetworkProfileMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}