Class DescribeEdgeDeploymentPlanResponse

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

  • Method Details

    • edgeDeploymentPlanArn

      public final String edgeDeploymentPlanArn()

      The ARN of edge deployment plan.

      Returns:
      The ARN of edge deployment plan.

    • edgeDeploymentPlanName

      public final String edgeDeploymentPlanName()

      The name of the edge deployment plan.

      Returns:
      The name of the edge deployment plan.

    • hasModelConfigs

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

    • modelConfigs

      public final List<EdgeDeploymentModelConfig> modelConfigs()

      List of models associated with the edge deployment plan.

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

      Returns:
      List of models associated with the edge deployment plan.

    • deviceFleetName

      public final String deviceFleetName()

      The device fleet used for this edge deployment plan.

      Returns:
      The device fleet used for this edge deployment plan.

    • edgeDeploymentSuccess

      public final Integer edgeDeploymentSuccess()

      The number of edge devices with the successful deployment.

      Returns:
      The number of edge devices with the successful deployment.

    • edgeDeploymentPending

      public final Integer edgeDeploymentPending()

      The number of edge devices yet to pick up deployment, or in progress.

      Returns:
      The number of edge devices yet to pick up deployment, or in progress.

    • edgeDeploymentFailed

      public final Integer edgeDeploymentFailed()

      The number of edge devices that failed the deployment.

      Returns:
      The number of edge devices that failed the deployment.

    • hasStages

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

    • stages

      public final List<DeploymentStageStatusSummary> stages()

      List of stages in the edge deployment plan.

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

      Returns:
      List of stages in the edge deployment plan.

    • nextToken

      public final String nextToken()

      Token to use when calling the next set of stages in the edge deployment plan.

      Returns:
      Token to use when calling the next set of stages in the edge deployment plan.

    • creationTime

      public final Instant creationTime()

      The time when the edge deployment plan was created.

      Returns:
      The time when the edge deployment plan was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The time when the edge deployment plan was last updated.

      Returns:
      The time when the edge deployment plan was last updated.

    • toBuilder

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

    • builder

      public static DescribeEdgeDeploymentPlanResponse.Builder builder()

    • serializableBuilderClass

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