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

Class ListObjectsResponse

java.lang.Object

software.amazon.awssdk.AmazonWebServiceResult<ResponseMetadata>

software.amazon.awssdk.services.s3.model.ListObjectsResponse

All Implemented Interfaces:

ToCopyableBuilder<ListObjectsResponse.Builder,ListObjectsResponse>

@Generated("software.amazon.awssdk:codegen")
public class ListObjectsResponse
extends AmazonWebServiceResult<ResponseMetadata>
implements ToCopyableBuilder<ListObjectsResponse.Builder,ListObjectsResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListObjectsResponse.Builder

Method Summary

Modifier and Type	Method	Description
static ListObjectsResponse.Builder	builder()
List<CommonPrefix>	commonPrefixes()
List<S3Object>	contents()
String	delimiter()
String	encodingType()	Encoding type used by Amazon S3 to encode object keys in the response.
boolean	equals(Object obj)
int	hashCode()
Boolean	isTruncated()	A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.
String	marker()
Integer	maxKeys()
String	name()
String	nextMarker()	When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects.
String	prefix()
static Class<? extends ListObjectsResponse.Builder>	serializableBuilderClass()
ListObjectsResponse.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceResult

setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

isTruncated

public Boolean isTruncated()

A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.

Returns:

A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.

marker

public String marker()

Returns:

nextMarker

public String nextMarker()

When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.

Returns:

When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.

contents

public List<S3Object> contents()

Returns:

name

public String name()

Returns:

prefix

public String prefix()

Returns:

delimiter

public String delimiter()

Returns:

maxKeys

public Integer maxKeys()

Returns:

commonPrefixes

public List<CommonPrefix> commonPrefixes()

Returns:

encodingType

public String encodingType()

Encoding type used by Amazon S3 to encode object keys in the response.

Returns:

Encoding type used by Amazon S3 to encode object keys in the response.

See Also:

EncodingType

toBuilder

public ListObjectsResponse.Builder 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 interface ToCopyableBuilder<ListObjectsResponse.Builder,ListObjectsResponse>

Returns:

a builder for type T

builder

public static ListObjectsResponse.Builder builder()

serializableBuilderClass

public static Class<? extends ListObjectsResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object