Class GetManagedThingResponse

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.GetManagedThingResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetManagedThingResponse.Builder,GetManagedThingResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetManagedThingResponse extends IotManagedIntegrationsResponse implements ToCopyableBuilder<GetManagedThingResponse.Builder,GetManagedThingResponse>

  • Method Details

    • id

      public final String id()

      The id of the managed thing.

      Returns:
      The id of the managed thing.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the managed thing.

      Returns:
      The Amazon Resource Name (ARN) of the managed thing.

    • owner

      public final String owner()

      Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.

      Returns:
      Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.

    • credentialLockerId

      public final String credentialLockerId()

      The identifier of the credential locker for the managed thing.

      Returns:
      The identifier of the credential locker for the managed thing.

    • advertisedProductId

      public final String advertisedProductId()

      The id of the advertised product.

      Returns:
      The id of the advertised product.

    • role

      public final Role role()

      The type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device.

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

      Returns:
      The type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device.
      See Also:

    • roleAsString

      public final String roleAsString()

      The type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device.

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

      Returns:
      The type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device.
      See Also:

    • provisioningStatus

      public final ProvisioningStatus provisioningStatus()

      The provisioning status of the device in the provisioning workflow for onboarding to IoT managed integrations.

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

      Returns:
      The provisioning status of the device in the provisioning workflow for onboarding to IoT managed integrations.
      See Also:

    • provisioningStatusAsString

      public final String provisioningStatusAsString()

      The provisioning status of the device in the provisioning workflow for onboarding to IoT managed integrations.

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

      Returns:
      The provisioning status of the device in the provisioning workflow for onboarding to IoT managed integrations.
      See Also:

    • name

      public final String name()

      The name of the managed thing representing the physical device.

      Returns:
      The name of the managed thing representing the physical device.

    • model

      public final String model()

      The model of the device.

      Returns:
      The model of the device.

    • brand

      public final String brand()

      The brand of the device.

      Returns:
      The brand of the device.

    • serialNumber

      public final String serialNumber()

      The serial number of the device.

      Returns:
      The serial number of the device.

    • universalProductCode

      public final String universalProductCode()

      The universal product code (UPC) of the device model. The UPC is typically used in the United States of America and Canada.

      Returns:
      The universal product code (UPC) of the device model. The UPC is typically used in the United States of America and Canada.

    • internationalArticleNumber

      public final String internationalArticleNumber()

      The unique 13 digit number that identifies the managed thing.

      Returns:
      The unique 13 digit number that identifies the managed thing.

    • connectorPolicyId

      @Deprecated public final String connectorPolicyId()
      Deprecated.
      ConnectorPolicyId is deprecated

      The id of the connector policy.

      This parameter is used for cloud-to-cloud devices only.

      Returns:
      The id of the connector policy.

      This parameter is used for cloud-to-cloud devices only.

    • connectorDestinationId

      public final String connectorDestinationId()

      The identifier of the connector destination associated with this managed thing.

      Returns:
      The identifier of the connector destination associated with this managed thing.

    • connectorDeviceId

      public final String connectorDeviceId()

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

      This parameter is used for cloud-to-cloud devices only.

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

      This parameter is used for cloud-to-cloud devices only.

    • deviceSpecificKey

      public final String deviceSpecificKey()

      A Zwave device-specific key used during device activation.

      This parameter is used for Zwave devices only.

      Returns:
      A Zwave device-specific key used during device activation.

      This parameter is used for Zwave devices only.

    • macAddress

      public final String macAddress()

      The media access control (MAC) address for the device represented by the managed thing.

      This parameter is used for Zigbee devices only.

      Returns:
      The media access control (MAC) address for the device represented by the managed thing.

      This parameter is used for Zigbee devices only.

    • parentControllerId

      public final String parentControllerId()

      Id of the controller device used for the discovery job.

      Returns:
      Id of the controller device used for the discovery job.

    • classification

      public final String classification()

      The classification of the managed thing such as light bulb or thermostat.

      Returns:
      The classification of the managed thing such as light bulb or thermostat.

    • createdAt

      public final Instant createdAt()

      The timestamp value of when the device creation request occurred.

      Returns:
      The timestamp value of when the device creation request occurred.

    • updatedAt

      public final Instant updatedAt()

      The timestamp value of when the managed thing was last updated at.

      Returns:
      The timestamp value of when the managed thing was last updated at.

    • activatedAt

      public final Instant activatedAt()

      The timestampe value of when the device was activated.

      Returns:
      The timestampe value of when the device was activated.

    • hubNetworkMode

      public final HubNetworkMode hubNetworkMode()

      The network mode for the hub-connected device.

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

      Returns:
      The network mode for the hub-connected device.
      See Also:

    • hubNetworkModeAsString

      public final String hubNetworkModeAsString()

      The network mode for the hub-connected device.

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

      Returns:
      The network mode for the hub-connected device.
      See Also:

    • hasMetaData

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

    • metaData

      public final Map<String,String> metaData()

      The metadata for the managed thing.

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

      Returns:
      The metadata for the managed thing.

    • 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 Map<String,String> tags()

      A set of key/value pairs that are used to manage the managed thing.

      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 managed thing.

    • toBuilder

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

    • builder

      public static GetManagedThingResponse.Builder builder()

    • serializableBuilderClass

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