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

Class CommonPrefix

java.lang.Object

software.amazon.awssdk.services.s3.model.CommonPrefix

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CommonPrefix.Builder,CommonPrefix>

@Generated("software.amazon.awssdk:codegen")
public final class CommonPrefix
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CommonPrefix.Builder,CommonPrefix>

Container for all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CommonPrefix.Builder

Method Summary

Modifier and Type	Method	Description
static CommonPrefix.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	prefix()	Container for the specified common prefix.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends CommonPrefix.Builder>	serializableBuilderClass()
CommonPrefix.Builder	toBuilder()
final 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 Details

prefix

public final String prefix()

Container for the specified common prefix.

Returns:

Container for the specified common prefix.

toBuilder

public CommonPrefix.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CommonPrefix.Builder,CommonPrefix>

builder

public static CommonPrefix.Builder builder()

serializableBuilderClass

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