Class NetworkProfile
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<NetworkProfile.Builder,
NetworkProfile>
The network profile associated with a device.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic NetworkProfile.Builder
builder()
final String
The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM).final String
The current password of the Wi-Fi network.final String
Detailed information about a device's network profile.final NetworkEapMethod
The authentication standard that is used in the EAP framework.final String
The authentication standard that is used in the EAP framework.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the TrustAnchors property.final String
The ARN of the network profile associated with a device.final String
The name of the network profile associated with a device.final String
The next, or subsequent, password of the Wi-Fi network.final NetworkSecurityType
The security type of the Wi-Fi network.final String
The security type of the Wi-Fi network.static Class
<? extends NetworkProfile.Builder> final String
ssid()
The SSID of the Wi-Fi network.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
networkProfileArn
The ARN of the network profile associated with a device.
- Returns:
- The ARN of the network profile associated with a device.
-
networkProfileName
The name of the network profile associated with a device.
- Returns:
- The name of the network profile associated with a device.
-
description
Detailed information about a device's network profile.
- Returns:
- Detailed information about a device's network profile.
-
ssid
The SSID of the Wi-Fi network.
- Returns:
- The SSID of the Wi-Fi network.
-
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,
securityType
will 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:
-
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,
securityType
will 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:
-
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,
eapMethod
will 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:
-
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,
eapMethod
will 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:
-
currentPassword
The current password of the Wi-Fi network.
- Returns:
- The current password of the Wi-Fi network.
-
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
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<NetworkProfile.Builder,
NetworkProfile> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-