Class BackfillError

  • All Implemented Interfaces:
    Serializable, SdkPojo, ToCopyableBuilder<BackfillError.Builder,​BackfillError>

    @Generated("software.amazon.awssdk:codegen")
    public final class BackfillError
    extends Object
    implements SdkPojo, Serializable, ToCopyableBuilder<BackfillError.Builder,​BackfillError>

    A list of errors that can occur when registering partition indexes for an existing table.

    These errors give the details about why an index registration failed and provide a limited number of partitions in the response, so that you can fix the partitions at fault and try registering the index again. The most common set of errors that can occur are categorized as follows:

    • EncryptedPartitionError: The partitions are encrypted.

    • InvalidPartitionTypeDataError: The partition value doesn't match the data type for that partition column.

    • MissingPartitionValueError: The partitions are encrypted.

    • UnsupportedPartitionCharacterError: Characters inside the partition value are not supported. For example: U+0000 , U+0001, U+0002.

    • InternalError: Any error which does not belong to other error codes.

    See Also:
    Serialized Form
    • Method Detail

      • code

        public final BackfillErrorCode code()

        The error code for an error that occurred when registering partition indexes for an existing table.

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

        Returns:
        The error code for an error that occurred when registering partition indexes for an existing table.
        See Also:
        BackfillErrorCode
      • codeAsString

        public final String codeAsString()

        The error code for an error that occurred when registering partition indexes for an existing table.

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

        Returns:
        The error code for an error that occurred when registering partition indexes for an existing table.
        See Also:
        BackfillErrorCode
      • hasPartitions

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

        public final List<PartitionValueList> partitions()

        A list of a limited number of partitions in the response.

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

        Returns:
        A list of a limited number of partitions in the response.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)