Class CreateWirelessDeviceRequest

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

  • Method Details

    • type

      public final WirelessDeviceType type()

      The wireless device type.

      If the service returns an enum value that is not available in the current SDK version, type will return WirelessDeviceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The wireless device type.
      See Also:

    • typeAsString

      public final String typeAsString()

      The wireless device type.

      If the service returns an enum value that is not available in the current SDK version, type will return WirelessDeviceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The wireless device type.
      See Also:

    • name

      public final String name()

      The name of the new resource.

      Returns:
      The name of the new resource.

    • description

      public final String description()

      The description of the new resource.

      Returns:
      The description of the new resource.

    • destinationName

      public final String destinationName()

      The name of the destination to assign to the new wireless device.

      Returns:
      The name of the destination to assign to the new wireless device.

    • clientRequestToken

      public final String clientRequestToken()

      Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

      Returns:
      Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    • loRaWAN

      public final LoRaWANDevice loRaWAN()

      The device configuration information to use to create the wireless device.

      Returns:
      The device configuration information to use to create the wireless device.

    • 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 attach to the new wireless device. Tags are metadata that you can use to manage a resource.

      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 attach to the new wireless device. Tags are metadata that you can use to manage a resource.

    • positioning

      public final PositioningConfigStatus positioning()

      FPort values for the GNSS, stream, and ClockSync functions of the positioning information.

      If the service returns an enum value that is not available in the current SDK version, positioning will return PositioningConfigStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from positioningAsString().

      Returns:
      FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
      See Also:

    • positioningAsString

      public final String positioningAsString()

      FPort values for the GNSS, stream, and ClockSync functions of the positioning information.

      If the service returns an enum value that is not available in the current SDK version, positioning will return PositioningConfigStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from positioningAsString().

      Returns:
      FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
      See Also:

    • sidewalk

      public final SidewalkCreateWirelessDevice sidewalk()

      The device configuration information to use to create the Sidewalk device.

      Returns:
      The device configuration information to use to create the Sidewalk device.

    • toBuilder

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

    • builder

      public static CreateWirelessDeviceRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateWirelessDeviceRequest.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.