Class DeviceDiscoverySummary

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

Structure containing summary information about a device discovery job, including its identifier, type, and status.

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier of the device discovery job.

      Returns:
      The unique identifier of the device discovery job.

    • discoveryType

      public final DiscoveryType discoveryType()

      The type of discovery process used to find devices.

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

      Returns:
      The type of discovery process used to find devices.
      See Also:

    • discoveryTypeAsString

      public final String discoveryTypeAsString()

      The type of discovery process used to find devices.

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

      Returns:
      The type of discovery process used to find devices.
      See Also:

    • status

      public final DeviceDiscoveryStatus status()

      The current status of the device discovery job.

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

      Returns:
      The current status of the device discovery job.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the device discovery job.

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

      Returns:
      The current status of the device discovery job.
      See Also:

    • toBuilder

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

    • builder

      public static DeviceDiscoverySummary.Builder builder()

    • serializableBuilderClass

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