Class FilterRule
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic FilterRule.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final FilterRuleName
name()
The object key name prefix or suffix identifying one or more objects to which the filtering rule applies.final String
The object key name prefix or suffix identifying one or more objects to which the filtering rule applies.static Class
<? extends FilterRule.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
value()
The value that the filter searches for in object key names.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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:
-
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:
-
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
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 interfaceToCopyableBuilder<FilterRule.Builder,
FilterRule> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-