Class CreateDeviceRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateDeviceRequest.Builder,
CreateDeviceRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AWSLocation
The Amazon Web Services location of the device, if applicable.static CreateDeviceRequest.Builder
builder()
final String
A description of the device.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) Used to retrieve the value of a field from any class that extendsSdkRequest
.final String
The ID of the global network.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Location
location()
The location of the device.final String
model()
The model of the device.static Class
<? extends CreateDeviceRequest.Builder> final String
The serial number of the device.final String
siteId()
The ID of the site.tags()
The tags to apply to the resource during creation.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.final String
type()
The type of the device.final String
vendor()
The vendor of the device.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
globalNetworkId
The ID of the global network.
- Returns:
- The ID of the global network.
-
awsLocation
The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.
- Returns:
- The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.
-
description
A description of the device.
Constraints: Maximum length of 256 characters.
- Returns:
- A description of the device.
Constraints: Maximum length of 256 characters.
-
type
The type of the device.
- Returns:
- The type of the device.
-
vendor
The vendor of the device.
Constraints: Maximum length of 128 characters.
- Returns:
- The vendor of the device.
Constraints: Maximum length of 128 characters.
-
model
The model of the device.
Constraints: Maximum length of 128 characters.
- Returns:
- The model of the device.
Constraints: Maximum length of 128 characters.
-
serialNumber
The serial number of the device.
Constraints: Maximum length of 128 characters.
- Returns:
- The serial number of the device.
Constraints: Maximum length of 128 characters.
-
location
The location of the device.
- Returns:
- The location of the device.
-
siteId
The ID of the site.
- Returns:
- The ID of the site.
-
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
The tags to apply to the resource during creation.
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 apply to the resource during creation.
-
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<CreateDeviceRequest.Builder,
CreateDeviceRequest> - Specified by:
toBuilder
in classNetworkManagerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-