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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateWirelessDeviceRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateWirelessDeviceRequest.Builderbuilder()StringclientRequestToken()Each resource must have a unique client request token.Stringdescription()The description of the new resource.StringdestinationName()The name of the destination to assign to the new wireless device.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.LoRaWANDeviceloRaWAN()The device configuration information to use to create the wireless device.Stringname()The name of the new resource.PositioningConfigStatuspositioning()FPort values for the GNSS, stream, and ClockSync functions of the positioning information.StringpositioningAsString()FPort values for the GNSS, stream, and ClockSync functions of the positioning information.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateWirelessDeviceRequest.Builder>serializableBuilderClass()SidewalkCreateWirelessDevicesidewalk()The device configuration information to use to create the Sidewalk device.List<Tag>tags()The tags to attach to the new wireless device.CreateWirelessDeviceRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.WirelessDeviceTypetype()The wireless device type.StringtypeAsString()The wireless device type.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
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,
typewill returnWirelessDeviceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The wireless device type.
- See Also:
WirelessDeviceType
-
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,
typewill returnWirelessDeviceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The wireless device type.
- See Also:
WirelessDeviceType
-
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 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.
-
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,
positioningwill returnPositioningConfigStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompositioningAsString().- Returns:
- FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
- See Also:
PositioningConfigStatus
-
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,
positioningwill returnPositioningConfigStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompositioningAsString().- Returns:
- FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
- See Also:
PositioningConfigStatus
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateWirelessDeviceRequest.Builder,CreateWirelessDeviceRequest>- Specified by:
toBuilderin classIotWirelessRequest
-
builder
public static CreateWirelessDeviceRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateWirelessDeviceRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-