Class DescribeDeviceResponse

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

  • Method Details

    • hasAlternateSoftwares

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

    • alternateSoftwares

      public final List<AlternateSoftwareMetadata> alternateSoftwares()

      Beta software releases available 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 hasAlternateSoftwares() method.

      Returns:
      Beta software releases available for the device.

    • arn

      public final String arn()

      The device's ARN.

      Returns:
      The device's ARN.

    • brand

      public final DeviceBrand brand()

      The device's maker.

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

      Returns:
      The device's maker.
      See Also:

    • brandAsString

      public final String brandAsString()

      The device's maker.

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

      Returns:
      The device's maker.
      See Also:

    • createdTime

      public final Instant createdTime()

      When the device was created.

      Returns:
      When the device was created.

    • currentNetworkingStatus

      public final NetworkStatus currentNetworkingStatus()

      The device's networking status.

      Returns:
      The device's networking status.

    • currentSoftware

      public final String currentSoftware()

      The device's current software version.

      Returns:
      The device's current software version.

    • description

      public final String description()

      The device's description.

      Returns:
      The device's description.

    • deviceAggregatedStatus

      public final DeviceAggregatedStatus deviceAggregatedStatus()

      A device's aggregated status. Including the device's connection status, provisioning status, and lease status.

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

      Returns:
      A device's aggregated status. Including the device's connection status, provisioning status, and lease status.
      See Also:

    • deviceAggregatedStatusAsString

      public final String deviceAggregatedStatusAsString()

      A device's aggregated status. Including the device's connection status, provisioning status, and lease status.

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

      Returns:
      A device's aggregated status. Including the device's connection status, provisioning status, and lease status.
      See Also:

    • deviceConnectionStatus

      public final DeviceConnectionStatus deviceConnectionStatus()

      The device's connection status.

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

      Returns:
      The device's connection status.
      See Also:

    • deviceConnectionStatusAsString

      public final String deviceConnectionStatusAsString()

      The device's connection status.

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

      Returns:
      The device's connection status.
      See Also:

    • deviceId

      public final String deviceId()

      The device's ID.

      Returns:
      The device's ID.

    • latestAlternateSoftware

      public final String latestAlternateSoftware()

      The most recent beta software release.

      Returns:
      The most recent beta software release.

    • latestDeviceJob

      public final LatestDeviceJob latestDeviceJob()

      A device's latest job. Includes the target image version, and the job status.

      Returns:
      A device's latest job. Includes the target image version, and the job status.

    • latestSoftware

      public final String latestSoftware()

      The latest software version available for the device.

      Returns:
      The latest software version available for the device.

    • leaseExpirationTime

      public final Instant leaseExpirationTime()

      The device's lease expiration time.

      Returns:
      The device's lease expiration time.

    • name

      public final String name()

      The device's name.

      Returns:
      The device's name.

    • networkingConfiguration

      public final NetworkPayload networkingConfiguration()

      The device's networking configuration.

      Returns:
      The device's networking configuration.

    • provisioningStatus

      public final DeviceStatus provisioningStatus()

      The device's provisioning status.

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

      Returns:
      The device's provisioning status.
      See Also:

    • provisioningStatusAsString

      public final String provisioningStatusAsString()

      The device's provisioning status.

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

      Returns:
      The device's provisioning status.
      See Also:

    • serialNumber

      public final String serialNumber()

      The device's serial number.

      Returns:
      The device's serial number.

    • 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()

      The device's tags.

      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 device's tags.

    • type

      public final DeviceType type()

      The device's type.

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

      Returns:
      The device's type.
      See Also:

    • typeAsString

      public final String typeAsString()

      The device's type.

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

      Returns:
      The device's type.
      See Also:

    • toBuilder

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

    • builder

      public static DescribeDeviceResponse.Builder builder()

    • serializableBuilderClass

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