software.amazon.awssdk.services.networkmanager.model

Class CreateDeviceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.networkmanager.model.NetworkManagerRequest

software.amazon.awssdk.services.networkmanager.model.CreateDeviceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateDeviceRequest.Builder,CreateDeviceRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateDeviceRequest
extends NetworkManagerRequest
implements ToCopyableBuilder<CreateDeviceRequest.Builder,CreateDeviceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDeviceRequest.Builder

Method Summary

Modifier and Type	Method and Description
AWSLocation	awsLocation() The Amazon Web Services location of the device, if applicable.
static CreateDeviceRequest.Builder	builder()
String	description() A description of the device.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	globalNetworkId() The ID of the global network.
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
Location	location() The location of the device.
String	model() The model of the device.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDeviceRequest.Builder>	serializableBuilderClass()
String	serialNumber() The serial number of the device.
String	siteId() The ID of the site.
List<Tag>	tags() The tags to apply to the resource during creation.
CreateDeviceRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	type() The type of the device.
String	vendor() The vendor of the device.

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

globalNetworkId

public final String globalNetworkId()

The ID of the global network.

Returns:

The ID of the global network.

awsLocation

public final AWSLocation 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

public final String 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

public final String type()

The type of the device.

Returns:

The type of the device.

vendor

public final String 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

public final String 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

public final String 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

public final Location location()

The location of the device.

Returns:

The location of the device.

siteId

public final String 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 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 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

public CreateDeviceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDeviceRequest.Builder,CreateDeviceRequest>

Specified by:

toBuilder in class NetworkManagerRequest

builder

public static CreateDeviceRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo