Class JobError

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

An error that occurred with the job request.

See Also:

  • Method Details

    • code

      public final Code code()

      The code for the job error.

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

      Returns:
      The code for the job error.
      See Also:

    • codeAsString

      public final String codeAsString()

      The code for the job error.

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

      Returns:
      The code for the job error.
      See Also:

    • details

      public final Details details()

      The details about the job error.

      Returns:
      The details about the job error.

    • limitName

      public final JobErrorLimitName limitName()

      The name of the limit that was reached.

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

      Returns:
      The name of the limit that was reached.
      See Also:

    • limitNameAsString

      public final String limitNameAsString()

      The name of the limit that was reached.

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

      Returns:
      The name of the limit that was reached.
      See Also:

    • limitValue

      public final Double limitValue()

      The value of the exceeded limit.

      Returns:
      The value of the exceeded limit.

    • message

      public final String message()

      The message related to the job error.

      Returns:
      The message related to the job error.

    • resourceId

      public final String resourceId()

      The unique identifier for the resource related to the error.

      Returns:
      The unique identifier for the resource related to the error.

    • resourceType

      public final JobErrorResourceTypes resourceType()

      The type of resource related to the error.

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

      Returns:
      The type of resource related to the error.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of resource related to the error.

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

      Returns:
      The type of resource related to the error.
      See Also:

    • toBuilder

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

    • builder

      public static JobError.Builder builder()

    • serializableBuilderClass

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