Class DeviceDeploymentSummary

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

Contains information summarizing device details and deployment status.

See Also:

  • Method Details

    • edgeDeploymentPlanArn

      public final String edgeDeploymentPlanArn()

      The ARN of the edge deployment plan.

      Returns:
      The ARN of the edge deployment plan.

    • edgeDeploymentPlanName

      public final String edgeDeploymentPlanName()

      The name of the edge deployment plan.

      Returns:
      The name of the edge deployment plan.

    • stageName

      public final String stageName()

      The name of the stage in the edge deployment plan.

      Returns:
      The name of the stage in the edge deployment plan.

    • deployedStageName

      public final String deployedStageName()

      The name of the deployed stage.

      Returns:
      The name of the deployed stage.

    • deviceFleetName

      public final String deviceFleetName()

      The name of the fleet to which the device belongs to.

      Returns:
      The name of the fleet to which the device belongs to.

    • deviceName

      public final String deviceName()

      The name of the device.

      Returns:
      The name of the device.

    • deviceArn

      public final String deviceArn()

      The ARN of the device.

      Returns:
      The ARN of the device.

    • deviceDeploymentStatus

      public final DeviceDeploymentStatus deviceDeploymentStatus()

      The deployment status of the device.

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

      Returns:
      The deployment status of the device.
      See Also:

    • deviceDeploymentStatusAsString

      public final String deviceDeploymentStatusAsString()

      The deployment status of the device.

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

      Returns:
      The deployment status of the device.
      See Also:

    • deviceDeploymentStatusMessage

      public final String deviceDeploymentStatusMessage()

      The detailed error message for the deployoment status result.

      Returns:
      The detailed error message for the deployoment status result.

    • description

      public final String description()

      The description of the device.

      Returns:
      The description of the device.

    • deploymentStartTime

      public final Instant deploymentStartTime()

      The time when the deployment on the device started.

      Returns:
      The time when the deployment on the device started.

    • toBuilder

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

    • builder

      public static DeviceDeploymentSummary.Builder builder()

    • serializableBuilderClass

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