Class DiscoveredDeviceSummary

java.lang.Object
software.amazon.awssdk.services.iotmanagedintegrations.model.DiscoveredDeviceSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DiscoveredDeviceSummary.Builder,DiscoveredDeviceSummary>
@Generated("software.amazon.awssdk:codegen") public final class DiscoveredDeviceSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DiscoveredDeviceSummary.Builder,DiscoveredDeviceSummary>

Structure containing summary information about a device discovered during a device discovery job.

See Also:

  • Method Details

    • connectorDeviceId

      public final String connectorDeviceId()

      The third-party device identifier as defined by the connector. This identifier must not contain personal identifiable information (PII).

      Returns:
      The third-party device identifier as defined by the connector. This identifier must not contain personal identifiable information (PII).

    • connectorDeviceName

      public final String connectorDeviceName()

      The name of the device as defined by the connector or third-party system.

      Returns:
      The name of the device as defined by the connector or third-party system.

    • hasDeviceTypes

      public final boolean hasDeviceTypes()
      For responses, this returns true if the service returned a value for the DeviceTypes 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.

    • deviceTypes

      public final List<String> deviceTypes()

      The list of device types or categories that the discovered device belongs to.

      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 hasDeviceTypes() method.

      Returns:
      The list of device types or categories that the discovered device belongs to.

    • managedThingId

      public final String managedThingId()

      The identifier of the managed thing created for this discovered device, if one exists.

      Returns:
      The identifier of the managed thing created for this discovered device, if one exists.

    • modification

      public final DiscoveryModification modification()

      The status of the discovered device, indicating whether it has been added, removed, or modified since the last discovery.

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

      Returns:
      The status of the discovered device, indicating whether it has been added, removed, or modified since the last discovery.
      See Also:

    • modificationAsString

      public final String modificationAsString()

      The status of the discovered device, indicating whether it has been added, removed, or modified since the last discovery.

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

      Returns:
      The status of the discovered device, indicating whether it has been added, removed, or modified since the last discovery.
      See Also:

    • discoveredAt

      public final Instant discoveredAt()

      The timestamp indicating when the device was discovered.

      Returns:
      The timestamp indicating when the device was discovered.

    • brand

      public final String brand()

      The brand of the discovered device.

      Returns:
      The brand of the discovered device.

    • model

      public final String model()

      The model of the discovered device.

      Returns:
      The model of the discovered device.

    • authenticationMaterial

      public final String authenticationMaterial()

      The authentication material required for connecting to the discovered device, such as credentials or tokens.

      Returns:
      The authentication material required for connecting to the discovered device, such as credentials or tokens.

    • toBuilder

      public DiscoveredDeviceSummary.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<DiscoveredDeviceSummary.Builder,DiscoveredDeviceSummary>
      Returns:
      a builder for type T

    • builder

      public static DiscoveredDeviceSummary.Builder builder()

    • serializableBuilderClass

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

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.