software.amazon.awssdk.services.networkmanager.model

Class Device

java.lang.Object

software.amazon.awssdk.services.networkmanager.model.Device

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Device.Builder,Device>

@Generated(value="software.amazon.awssdk:codegen")
public final class Device
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Device.Builder,Device>

Describes a device.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Device.Builder

Method Summary

Modifier and Type	Method and Description
AWSLocation	awsLocation() The Amazon Web Services location of the device.
static Device.Builder	builder()
Instant	createdAt() The date and time that the site was created.
String	description() The description of the device.
String	deviceArn() The Amazon Resource Name (ARN) of the device.
String	deviceId() The ID 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 site location.
String	model() The device model.
List<SdkField<?>>	sdkFields()
static Class<? extends Device.Builder>	serializableBuilderClass()
String	serialNumber() The device serial number.
String	siteId() The site ID.
DeviceState	state() The device state.
String	stateAsString() The device state.
List<Tag>	tags() The tags for the device.
Device.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	type() The device type.
String	vendor() The device vendor.

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

deviceId

public final String deviceId()

The ID of the device.

Returns:

The ID of the device.

deviceArn

public final String deviceArn()

The Amazon Resource Name (ARN) of the device.

Returns:

The Amazon Resource Name (ARN) of the device.

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.

Returns:

The Amazon Web Services location of the device.

description

public final String description()

The description of the device.

Returns:

The description of the device.

type

public final String type()

The device type.

Returns:

The device type.

vendor

public final String vendor()

The device vendor.

Returns:

The device vendor.

model

public final String model()

The device model.

Returns:

The device model.

serialNumber

public final String serialNumber()

The device serial number.

Returns:

The device serial number.

location

public final Location location()

The site location.

Returns:

The site location.

siteId

public final String siteId()

The site ID.

Returns:

The site ID.

createdAt

public final Instant createdAt()

The date and time that the site was created.

Returns:

The date and time that the site was created.

state

public final DeviceState state()

The device state.

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

Returns:

The device state.

See Also:

DeviceState

stateAsString

public final String stateAsString()

The device state.

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

Returns:

The device state.

See Also:

DeviceState

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 for the device.

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 for the device.

toBuilder

public Device.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Device.Builder,Device>

builder

public static Device.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo