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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface KeyNameConstraint.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static KeyNameConstraint.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasMatchAnyPrefix()`	For responses, this returns true if the service returned a value for the MatchAnyPrefix property.
`boolean`	`hasMatchAnySubstring()`	For responses, this returns true if the service returned a value for the MatchAnySubstring property.
`boolean`	`hasMatchAnySuffix()`	For responses, this returns true if the service returned a value for the MatchAnySuffix property.
`List<String>`	`matchAnyPrefix()`	If provided, the generated manifest includes objects where the specified string appears at the start of the object key string.
`List<String>`	`matchAnySubstring()`	If provided, the generated manifest includes objects where the specified string appears anywhere within the object key string.
`List<String>`	`matchAnySuffix()`	If provided, the generated manifest includes objects where the specified string appears at the end of the object key string.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends KeyNameConstraint.Builder>`	`serializableBuilderClass()`
`KeyNameConstraint.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<KeyNameConstraint.Builder,KeyNameConstraint>
  - 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)
```
    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

Class KeyNameConstraint

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasMatchAnyPrefix

matchAnyPrefix

hasMatchAnySuffix

matchAnySuffix

hasMatchAnySubstring

matchAnySubstring

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields