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-
orengineering/
. Then, you can useFilterRule
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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
FilterRule.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FilterRule.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
FilterRuleName
name()
The object key name prefix or suffix identifying one or more objects to which the filtering rule applies.String
nameAsString()
The object key name prefix or suffix identifying one or more objects to which the filtering rule applies.List<SdkField<?>>
sdkFields()
static Class<? extends FilterRule.Builder>
serializableBuilderClass()
FilterRule.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
value()
The value that the filter searches for in object key names.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 returnFilterRuleName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- 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:
FilterRuleName
-
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 returnFilterRuleName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- 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:
FilterRuleName
-
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 interfaceToCopyableBuilder<FilterRule.Builder,FilterRule>
-
builder
public static FilterRule.Builder builder()
-
serializableBuilderClass
public static Class<? extends FilterRule.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-