Class NetworkProfile
- java.lang.Object
-
- software.amazon.awssdk.services.alexaforbusiness.model.NetworkProfile
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<NetworkProfile.Builder,NetworkProfile>
@Generated("software.amazon.awssdk:codegen") public final class NetworkProfile extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NetworkProfile.Builder,NetworkProfile>
The network profile associated with a device.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceNetworkProfile.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static NetworkProfile.Builderbuilder()StringcertificateAuthorityArn()The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM).StringcurrentPassword()The current password of the Wi-Fi network.Stringdescription()Detailed information about a device's network profile.NetworkEapMethodeapMethod()The authentication standard that is used in the EAP framework.StringeapMethodAsString()The authentication standard that is used in the EAP framework.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTrustAnchors()For responses, this returns true if the service returned a value for the TrustAnchors property.StringnetworkProfileArn()The ARN of the network profile associated with a device.StringnetworkProfileName()The name of the network profile associated with a device.StringnextPassword()The next, or subsequent, password of the Wi-Fi network.List<SdkField<?>>sdkFields()NetworkSecurityTypesecurityType()The security type of the Wi-Fi network.StringsecurityTypeAsString()The security type of the Wi-Fi network.static Class<? extends NetworkProfile.Builder>serializableBuilderClass()Stringssid()The SSID of the Wi-Fi network.NetworkProfile.BuildertoBuilder()StringtoString()Returns a string representation of this object.List<String>trustAnchors()The root certificates of your authentication server, which is installed on your devices and used to trust your authentication server during EAP negotiation.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
networkProfileArn
public final String networkProfileArn()
The ARN of the network profile associated with a device.
- Returns:
- The ARN of the network profile associated with a device.
-
networkProfileName
public final String networkProfileName()
The name of the network profile associated with a device.
- Returns:
- The name of the network profile associated with a device.
-
description
public final String description()
Detailed information about a device's network profile.
- Returns:
- Detailed information about a device's network profile.
-
ssid
public final String ssid()
The SSID of the Wi-Fi network.
- Returns:
- The SSID of the Wi-Fi network.
-
securityType
public final NetworkSecurityType securityType()
The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
If the service returns an enum value that is not available in the current SDK version,
securityTypewill returnNetworkSecurityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsecurityTypeAsString().- Returns:
- The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
- See Also:
NetworkSecurityType
-
securityTypeAsString
public final String securityTypeAsString()
The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
If the service returns an enum value that is not available in the current SDK version,
securityTypewill returnNetworkSecurityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsecurityTypeAsString().- Returns:
- The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
- See Also:
NetworkSecurityType
-
eapMethod
public final NetworkEapMethod eapMethod()
The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
If the service returns an enum value that is not available in the current SDK version,
eapMethodwill returnNetworkEapMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromeapMethodAsString().- Returns:
- The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
- See Also:
NetworkEapMethod
-
eapMethodAsString
public final String eapMethodAsString()
The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
If the service returns an enum value that is not available in the current SDK version,
eapMethodwill returnNetworkEapMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromeapMethodAsString().- Returns:
- The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
- See Also:
NetworkEapMethod
-
currentPassword
public final String currentPassword()
The current password of the Wi-Fi network.
- Returns:
- The current password of the Wi-Fi network.
-
nextPassword
public final String 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.
- Returns:
- 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.
-
certificateAuthorityArn
public final String certificateAuthorityArn()
The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
- Returns:
- The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
-
hasTrustAnchors
public final boolean hasTrustAnchors()
For responses, this returns true if the service returned a value for the TrustAnchors property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
trustAnchors
public final List<String> trustAnchors()
The root certificates of your authentication server, which is installed on your devices and used to trust your authentication server during EAP negotiation.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTrustAnchors()method.- Returns:
- The root certificates of your authentication server, which is installed on your devices and used to trust your authentication server during EAP negotiation.
-
toBuilder
public NetworkProfile.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<NetworkProfile.Builder,NetworkProfile>
-
builder
public static NetworkProfile.Builder builder()
-
serializableBuilderClass
public static Class<? extends NetworkProfile.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
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.
-
-