software.amazon.awssdk.services.s3.model

Interface ListObjectsResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<ListObjectsResponse.Builder,ListObjectsResponse>, S3Response.Builder, SdkBuilder<ListObjectsResponse.Builder,ListObjectsResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

ListObjectsResponse

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

Method Summary

Modifier and Type	Method and Description
ListObjectsResponse.Builder	commonPrefixes(Collection<CommonPrefix> commonPrefixes) Sets the value of the CommonPrefixes property for this object.
ListObjectsResponse.Builder	commonPrefixes(CommonPrefix... commonPrefixes) Sets the value of the CommonPrefixes property for this object.
ListObjectsResponse.Builder	commonPrefixes(Consumer<CommonPrefix.Builder>... commonPrefixes) Sets the value of the CommonPrefixes property for this object.
ListObjectsResponse.Builder	contents(Collection<S3Object> contents) Sets the value of the Contents property for this object.
ListObjectsResponse.Builder	contents(Consumer<S3Object.Builder>... contents) Sets the value of the Contents property for this object.
ListObjectsResponse.Builder	contents(S3Object... contents) Sets the value of the Contents property for this object.
ListObjectsResponse.Builder	delimiter(String delimiter) Sets the value of the Delimiter property for this object.
ListObjectsResponse.Builder	encodingType(EncodingType encodingType) Encoding type used by Amazon S3 to encode object keys in the response.
ListObjectsResponse.Builder	encodingType(String 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) Sets the value of the Marker property for this object.
ListObjectsResponse.Builder	maxKeys(Integer maxKeys) Sets the value of the MaxKeys property for this object.
ListObjectsResponse.Builder	name(String name) Sets the value of the Name property for this object.
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) Sets the value of the Prefix property for this object.

Methods inherited from interface software.amazon.awssdk.services.s3.model.S3Response.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, 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)

Sets the value of the Marker property for this object.

Parameters:

marker - The new value for the Marker property for this object.

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)

Sets the value of the Contents property for this object.

Parameters:

contents - The new value for the Contents property for this object.

Returns:

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

contents

ListObjectsResponse.Builder contents(S3Object... contents)

Sets the value of the Contents property for this object.

Parameters:

contents - The new value for the Contents property for this object.

Returns:

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

contents

ListObjectsResponse.Builder contents(Consumer<S3Object.Builder>... contents)

Sets the value of the Contents property for this object. This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #contents(List).

Parameters:

contents - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#contents(List)

name

ListObjectsResponse.Builder name(String name)

Sets the value of the Name property for this object.

Parameters:

name - The new value for the Name property for this object.

Returns:

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

prefix

ListObjectsResponse.Builder prefix(String prefix)

Sets the value of the Prefix property for this object.

Parameters:

prefix - The new value for the Prefix property for this object.

Returns:

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

delimiter

ListObjectsResponse.Builder delimiter(String delimiter)

Sets the value of the Delimiter property for this object.

Parameters:

delimiter - The new value for the Delimiter property for this object.

Returns:

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

maxKeys

ListObjectsResponse.Builder maxKeys(Integer maxKeys)

Sets the value of the MaxKeys property for this object.

Parameters:

maxKeys - The new value for the MaxKeys property for this object.

Returns:

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

commonPrefixes

ListObjectsResponse.Builder commonPrefixes(Collection<CommonPrefix> commonPrefixes)

Sets the value of the CommonPrefixes property for this object.

Parameters:

commonPrefixes - The new value for the CommonPrefixes property for this object.

Returns:

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

commonPrefixes

ListObjectsResponse.Builder commonPrefixes(CommonPrefix... commonPrefixes)

Sets the value of the CommonPrefixes property for this object.

Parameters:

commonPrefixes - The new value for the CommonPrefixes property for this object.

Returns:

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

commonPrefixes

ListObjectsResponse.Builder commonPrefixes(Consumer<CommonPrefix.Builder>... commonPrefixes)

Sets the value of the CommonPrefixes property for this object. This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #commonPrefixes(List).

Parameters:

commonPrefixes - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#commonPrefixes(List)

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

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, EncodingType