Class BatchAddClusterNodesError

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

Information about an error that occurred during the node addition operation.

See Also:

  • Method Details

    • instanceGroupName

      public final String instanceGroupName()

      The name of the instance group for which the error occurred.

      Returns:
      The name of the instance group for which the error occurred.

    • errorCode

      public final BatchAddClusterNodesErrorCode errorCode()

      The error code associated with the failure. Possible values include InstanceGroupNotFound and InvalidInstanceGroupState.

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

      Returns:
      The error code associated with the failure. Possible values include InstanceGroupNotFound and InvalidInstanceGroupState.
      See Also:

    • errorCodeAsString

      public final String errorCodeAsString()

      The error code associated with the failure. Possible values include InstanceGroupNotFound and InvalidInstanceGroupState.

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

      Returns:
      The error code associated with the failure. Possible values include InstanceGroupNotFound and InvalidInstanceGroupState.
      See Also:

    • failedCount

      public final Integer failedCount()

      The number of nodes that failed to be added to the specified instance group.

      Returns:
      The number of nodes that failed to be added to the specified instance group.

    • hasAvailabilityZones

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

    • availabilityZones

      public final List<String> availabilityZones()

      The availability zones associated with the failed node addition request.

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

      Returns:
      The availability zones associated with the failed node addition request.

    • instanceTypes

      public final List<ClusterInstanceType> instanceTypes()

      The instance types associated with the failed node addition request.

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

      Returns:
      The instance types associated with the failed node addition request.

    • hasInstanceTypes

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

    • instanceTypesAsStrings

      public final List<String> instanceTypesAsStrings()

      The instance types associated with the failed node addition request.

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

      Returns:
      The instance types associated with the failed node addition request.

    • message

      public final String message()

      A descriptive message providing additional details about the error.

      Returns:
      A descriptive message providing additional details about the error.

    • toBuilder

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

    • builder

      public static BatchAddClusterNodesError.Builder builder()

    • serializableBuilderClass

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