Class EdgeDeployment

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

Information about a deployment on an edge device that is registered with SageMaker Edge Manager.

See Also:

  • Method Details

    • deploymentName

      public final String deploymentName()

      The name and unique ID of the deployment.

      Returns:
      The name and unique ID of the deployment.

    • type

      public final DeploymentType type()

      The type of the deployment.

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

      Returns:
      The type of the deployment.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the deployment.

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

      Returns:
      The type of the deployment.
      See Also:

    • failureHandlingPolicy

      public final FailureHandlingPolicy failureHandlingPolicy()

      Determines whether to rollback to previous configuration if deployment fails.

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

      Returns:
      Determines whether to rollback to previous configuration if deployment fails.
      See Also:

    • failureHandlingPolicyAsString

      public final String failureHandlingPolicyAsString()

      Determines whether to rollback to previous configuration if deployment fails.

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

      Returns:
      Determines whether to rollback to previous configuration if deployment fails.
      See Also:

    • hasDefinitions

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

    • definitions

      public final List<Definition> definitions()

      Returns a list of Definition objects.

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

      Returns:
      Returns a list of Definition objects.

    • toBuilder

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

    • builder

      public static EdgeDeployment.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.