Class KeyRange

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

Contains a key range. For export jobs, a S3Resource object can have an optional KeyRange value. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted.

See Also:

  • Method Details

    • beginMarker

      public final String beginMarker()

      The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

      Returns:
      The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

    • endMarker

      public final String endMarker()

      The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

      Returns:
      The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

    • toBuilder

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

    • builder

      public static KeyRange.Builder builder()

    • serializableBuilderClass

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