Package software.amazon.awssdk.services.s3control.model

Class KeyNameConstraint

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

If provided, the generated manifest includes only source bucket objects whose object keys match the string constraints specified for MatchAnyPrefix, MatchAnySuffix, and MatchAnySubstring.

See Also:

  • Method Details

    • hasMatchAnyPrefix

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

    • matchAnyPrefix

      public final List<String> matchAnyPrefix()

      If provided, the generated manifest includes objects where the specified string appears at the start of the object key string.

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

      Returns:
      If provided, the generated manifest includes objects where the specified string appears at the start of the object key string.

    • hasMatchAnySuffix

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

    • matchAnySuffix

      public final List<String> matchAnySuffix()

      If provided, the generated manifest includes objects where the specified string appears at the end of the object key string.

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

      Returns:
      If provided, the generated manifest includes objects where the specified string appears at the end of the object key string.

    • hasMatchAnySubstring

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

    • matchAnySubstring

      public final List<String> matchAnySubstring()

      If provided, the generated manifest includes objects where the specified string appears anywhere within the object key string.

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

      Returns:
      If provided, the generated manifest includes objects where the specified string appears anywhere within the object key string.

    • toBuilder

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

    • builder

      public static KeyNameConstraint.Builder builder()

    • serializableBuilderClass

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