Package software.amazon.awssdk.services.s3.model

Class FilterRule

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

Specifies the Amazon S3 object key name to filter on. An object key name is the name assigned to an object in your Amazon S3 bucket. You specify whether to filter on the suffix or prefix of the object key name. A prefix is a specific string of characters at the beginning of an object key name, which you can use to organize objects. For example, you can start the key names of related objects with a prefix, such as 2023- or engineering/. Then, you can use FilterRule to find objects in a bucket with key names that have the same prefix. A suffix is similar to a prefix, but it is at the end of the object key name instead of at the beginning.

See Also:

  • Method Details

    • name

      public final FilterRuleName name()

      The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon S3 User Guide.

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

      Returns:
      The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon S3 User Guide.
      See Also:

    • nameAsString

      public final String nameAsString()

      The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon S3 User Guide.

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

      Returns:
      The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon S3 User Guide.
      See Also:

    • value

      public final String value()

      The value that the filter searches for in object key names.

      Returns:
      The value that the filter searches for in object key names.

    • toBuilder

      public FilterRule.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<FilterRule.Builder,FilterRule>

    • builder

      public static FilterRule.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FilterRule.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo