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

Interface ListObjectsResponse.Builder

All Superinterfaces:

CopyableBuilder<ListObjectsResponse.Builder,ListObjectsResponse>, SdkBuilder<ListObjectsResponse.Builder,ListObjectsResponse>

Enclosing class:

ListObjectsResponse

public static interface ListObjectsResponse.Builder
extends CopyableBuilder<ListObjectsResponse.Builder,ListObjectsResponse>

Method Summary

Modifier and Type	Method	Description
ListObjectsResponse.Builder	commonPrefixes(Collection<CommonPrefix> commonPrefixes)
ListObjectsResponse.Builder	commonPrefixes(CommonPrefix... commonPrefixes)	NOTE: This method appends the values to the existing list (if any).
ListObjectsResponse.Builder	contents(Collection<S3Object> contents)
ListObjectsResponse.Builder	contents(S3Object... contents)	NOTE: This method appends the values to the existing list (if any).
ListObjectsResponse.Builder	delimiter(String delimiter)
ListObjectsResponse.Builder	encodingType(String encodingType)	Encoding type used by Amazon S3 to encode object keys in the response.
ListObjectsResponse.Builder	encodingType(EncodingType encodingType)	Encoding type used by Amazon S3 to encode object keys in the response.
ListObjectsResponse.Builder	isTruncated(Boolean isTruncated)	A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.
ListObjectsResponse.Builder	marker(String marker)
ListObjectsResponse.Builder	maxKeys(Integer maxKeys)
ListObjectsResponse.Builder	name(String name)
ListObjectsResponse.Builder	nextMarker(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.
ListObjectsResponse.Builder	prefix(String prefix)

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

copy

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

apply, build

Method Detail

isTruncated

ListObjectsResponse.Builder isTruncated(Boolean isTruncated)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

marker

ListObjectsResponse.Builder marker(String marker)

Parameters:

marker -

Returns:

Returns a reference to this object so that method calls can be chained together.

nextMarker

ListObjectsResponse.Builder nextMarker(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

contents

ListObjectsResponse.Builder contents(Collection<S3Object> contents)

Parameters:

contents -

Returns:

Returns a reference to this object so that method calls can be chained together.

contents

ListObjectsResponse.Builder contents(S3Object... contents)

NOTE: This method appends the values to the existing list (if any). Use #setContents(java.util.Collection) or #withContents(java.util.Collection) if you want to override the existing values.

Parameters:

contents -

Returns:

Returns a reference to this object so that method calls can be chained together.

name

ListObjectsResponse.Builder name(String name)

Parameters:

name -

Returns:

Returns a reference to this object so that method calls can be chained together.

prefix

ListObjectsResponse.Builder prefix(String prefix)

Parameters:

prefix -

Returns:

Returns a reference to this object so that method calls can be chained together.

delimiter

ListObjectsResponse.Builder delimiter(String delimiter)

Parameters:

delimiter -

Returns:

Returns a reference to this object so that method calls can be chained together.

maxKeys

ListObjectsResponse.Builder maxKeys(Integer maxKeys)

Parameters:

maxKeys -

Returns:

Returns a reference to this object so that method calls can be chained together.

commonPrefixes

ListObjectsResponse.Builder commonPrefixes(Collection<CommonPrefix> commonPrefixes)

Parameters:

commonPrefixes -

Returns:

Returns a reference to this object so that method calls can be chained together.

commonPrefixes

ListObjectsResponse.Builder commonPrefixes(CommonPrefix... commonPrefixes)

NOTE: This method appends the values to the existing list (if any). Use #setCommonPrefixes(java.util.Collection) or #withCommonPrefixes(java.util.Collection) if you want to override the existing values.

Parameters:

commonPrefixes -

Returns:

Returns a reference to this object so that method calls can be chained together.

encodingType

ListObjectsResponse.Builder encodingType(String encodingType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EncodingType

encodingType

ListObjectsResponse.Builder encodingType(EncodingType encodingType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EncodingType