Class GetDeviceDiscoveryResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.iotmanagedintegrations.model.IotManagedIntegrationsResponse
software.amazon.awssdk.services.iotmanagedintegrations.model.GetDeviceDiscoveryResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetDeviceDiscoveryResponse.Builder,GetDeviceDiscoveryResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetDeviceDiscoveryResponse extends IotManagedIntegrationsResponse implements ToCopyableBuilder<GetDeviceDiscoveryResponse.Builder,GetDeviceDiscoveryResponse>

  • Method Details

    • id

      public final String id()

      The id of the device discovery job request.

      Returns:
      The id of the device discovery job request.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the device discovery job request.

      Returns:
      The Amazon Resource Name (ARN) of the device discovery job request.

    • discoveryType

      public final DiscoveryType discoveryType()

      The discovery type supporting the type of device to be discovered in the device discovery job request.

      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 discovery type supporting the type of device to be discovered in the device discovery job request.
      See Also:

    • discoveryTypeAsString

      public final String discoveryTypeAsString()

      The discovery type supporting the type of device to be discovered in the device discovery job request.

      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 discovery type supporting the type of device to be discovered in the device discovery job request.
      See Also:

    • status

      public final DeviceDiscoveryStatus status()

      The status of the device discovery job request.

      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 status of the device discovery job request.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the device discovery job request.

      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 status of the device discovery job request.
      See Also:

    • startedAt

      public final Instant startedAt()

      The timestamp value for the start time of the device discovery.

      Returns:
      The timestamp value for the start time of the device discovery.

    • controllerId

      public final String controllerId()

      The id of the end-user's IoT hub.

      Returns:
      The id of the end-user's IoT hub.

    • connectorAssociationId

      @Deprecated public final String connectorAssociationId()
      Deprecated.
      ConnectorAssociationId has been deprecated

      The ID tracking the current discovery process for one connector association.

      Returns:
      The ID tracking the current discovery process for one connector association.

    • accountAssociationId

      public final String accountAssociationId()

      The identifier of the account association used for the device discovery.

      Returns:
      The identifier of the account association used for the device discovery.

    • finishedAt

      public final Instant finishedAt()

      The timestamp value for the completion time of the device discovery.

      Returns:
      The timestamp value for the completion time of the device discovery.

    • hasTags

      @Deprecated public final boolean hasTags()
      Deprecated.
      Tags have been deprecated from this api
      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

      @Deprecated public final Map<String,String> tags()
      Deprecated.
      Tags have been deprecated from this api

      A set of key/value pairs that are used to manage the device discovery request.

      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:
      A set of key/value pairs that are used to manage the device discovery request.

    • toBuilder

      public GetDeviceDiscoveryResponse.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<GetDeviceDiscoveryResponse.Builder,GetDeviceDiscoveryResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetDeviceDiscoveryResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      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.