Package software.amazon.awssdk.services.alexaforbusiness.model

Class CreateNetworkProfileRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.alexaforbusiness.model.AlexaForBusinessRequest
software.amazon.awssdk.services.alexaforbusiness.model.CreateNetworkProfileRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateNetworkProfileRequest.Builder,CreateNetworkProfileRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateNetworkProfileRequest extends AlexaForBusinessRequest implements ToCopyableBuilder<CreateNetworkProfileRequest.Builder,CreateNetworkProfileRequest>

  • Method Details

    • 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, securityType will return NetworkSecurityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from securityTypeAsString().

      Returns:
      The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
      See Also:

    • 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, securityType will return NetworkSecurityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from securityTypeAsString().

      Returns:
      The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
      See Also:

    • 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, eapMethod will return NetworkEapMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eapMethodAsString().

      Returns:
      The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
      See Also:

    • 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, eapMethod will return NetworkEapMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eapMethodAsString().

      Returns:
      The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
      See Also:

    • 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 the isEmpty() 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 that 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 that is installed on your devices and used to trust your authentication server during EAP negotiation.

    • clientRequestToken

      public final String clientRequestToken()
      Returns the value of the ClientRequestToken property for this object.
      Returns:
      The value of the ClientRequestToken property for this object.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • tags

      public final List<Tag> tags()

      The tags to be added to the specified resource. Do not provide system tags.

      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 hasTags() method.

      Returns:
      The tags to be added to the specified resource. Do not provide system tags.

    • toBuilder

      public CreateNetworkProfileRequest.Builder 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 interface ToCopyableBuilder<CreateNetworkProfileRequest.Builder,CreateNetworkProfileRequest>
      Specified by:
      toBuilder in class AlexaForBusinessRequest
      Returns:
      a builder for type T

    • builder

      public static CreateNetworkProfileRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateNetworkProfileRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.